updated docs

Author: zliang-min

docs/data-sources/stream.md

@@ -39,6 +39,7 @@ output "example_stream" {
 
 - `columns` (Attributes List) The columns of the stream (see [below for nested schema](#nestedatt--columns))
 - `description` (String) A detailed text describes the stream
+- `mode` (String) The stream mode. Options: append, changelog, changelog_kv, versioned_kv. Default: "append"
 
 <a id="nestedatt--columns"></a>
 ### Nested Schema for `columns`
@@ -48,4 +49,6 @@ Read-Only:
 - `codec` (String) The codec for value encoding
 - `default` (String) The default value for the column
 - `name` (String) The column name
+- `primary_key` (Boolean) If set to `true`, this column will be used as the primary key, or part of the combined primary key if multiple columns are marked as primary keys.
 - `type` (String) The type name of the column
+- `use_as_event_time` (Boolean) If set to `true`, this column will be used as the event time column (by default ingest time will be used as event time). Only one column can be marked as the event time column in a stream.

docs/resources/stream.md

@@ -83,6 +83,25 @@ resource "timeplus_stream" "retention_example" {
   retention_ms    = 7 * 24 * 60 * 60 * 1000 // 7 days in ms 
   history_ttl     = "to_datetime(_tp_time) + INTERVAL 30 DAY"
 }
+
+resource "timeplus_stream" "mode_example" {
+  name = "mode_example"
+
+  description = "An example shows how to use different mode to create stream"
+
+  mode = "versioned_kv"
+
+  column {
+    name        = "id"
+    type        = "string"
+    primary_key = true
+  }
+
+  column {
+    name = "value"
+    type = "int32"
+  }
+}
 ```
 
 <!-- schema generated by tfplugindocs -->
@@ -91,15 +110,13 @@ resource "timeplus_stream" "retention_example" {
 ### Required
 
 - `name` (String) The stream name
-<!--
-  Due to the framework limitation, it's impossible to define a block attribute as `required`. Thus we need to manually move it to this `Required` section.
--->
-- `column` (Block List) Define the columns of the stream (see [below for nested schema](#nestedblock--column))
 
 ### Optional
 
+- `column` (Block List) Define the columns of the stream (see [below for nested schema](#nestedblock--column))
 - `description` (String) A detailed text describes the stream
 - `history_ttl` (String) A SQL expression defines the maximum age of data that are persisted in the historical store
+- `mode` (String) The stream mode. Options: append, changelog, changelog_kv, versioned_kv. Default: "append"
 - `retention_bytes` (Number) The retention size threadhold in bytes indicates how many data could be kept in the streaming store
 - `retention_ms` (Number) The retention period threadhold in millisecond indicates how long data could be kept in the streaming store
 
@@ -115,3 +132,5 @@ Optional:
 
 - `codec` (String) The codec for value encoding
 - `default` (String) The default value for the column
+- `primary_key` (Boolean) If set to `true`, this column will be used as the primary key, or part of the combined primary key if multiple columns are marked as primary keys.
+- `use_as_event_time` (Boolean) If set to `true`, this column will be used as the event time column (by default ingest time will be used as event time). Only one column can be marked as the event time column in a stream.