Merge pull request #218 from stackql/feature/doc-updates

digitalocean, google, googleadmin updates
stackql · Nov 15, 2024 · 015681f · 015681f
2 parents e3087ff + 5246d71
commit 015681f
Show file tree

Hide file tree

Showing 15 changed files with 521 additions and 144 deletions.
diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/database_clusters/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/database_clusters/index.md
@@ -123,20 +123,30 @@ Use the following StackQL query and manifest file to create a new <code>database
 ```sql
 /*+ create */
 INSERT INTO digitalocean.databases.database_clusters (
-data__backup_restore,
-data__engine,
 data__name,
+data__engine,
+data__version,
 data__num_nodes,
+data__size,
 data__region,
-data__size
+data__private_network_uuid,
+data__tags,
+data__project_id,
+data__rules,
+data__storage_size_mib
 )
 SELECT 
-'{{ backup_restore }}',
-'{{ engine }}',
 '{{ name }}',
+'{{ engine }}',
+'{{ version }}',
 '{{ num_nodes }}',
+'{{ size }}',
 '{{ region }}',
-'{{ size }}'
+'{{ private_network_uuid }}',
+'{{ tags }}',
+'{{ project_id }}',
+'{{ rules }}',
+'{{ storage_size_mib }}'
 ;
 ```
 </TabItem>
@@ -177,12 +187,37 @@ SELECT
       value: string
     - name: data__size
       value: string
-    - name: backup_restore
+    - name: name
+      value: string
+    - name: engine
+      value: string
+    - name: version
+      value: string
+    - name: num_nodes
+      value: integer
+    - name: size
+      value: string
+    - name: region
+      value: string
+    - name: private_network_uuid
+      value: string
+    - name: tags
+      value: array
+    - name: project_id
+      value: string
+    - name: rules
+      value: array
       props:
-        - name: database_name
+        - name: uuid
+          value: string
+        - name: cluster_uuid
+          value: string
+        - name: type
           value: string
-        - name: backup_created_at
+        - name: value
           value: string
+    - name: storage_size_mib
+      value: integer
 
 ```
 </TabItem>

diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/logsinks/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/logsinks/index.md
@@ -59,13 +59,32 @@ Use the following StackQL query and manifest file to create a new <code>logsinks
 <Tabs
     defaultValue="all"
     values={[
-
+        { label: 'Required Properties', value: 'required' },
         { label: 'All Properties', value: 'all', },
         { label: 'Manifest', value: 'manifest', },
     ]
 }>
 <TabItem value="all">
 
+```sql
+/*+ create */
+INSERT INTO digitalocean.databases.logsinks (
+data__sink_name,
+data__sink_type,
+data__config,
+database_cluster_uuid
+)
+SELECT 
+'{{ sink_name }}',
+'{{ sink_type }}',
+'{{ config }}',
+'{{ database_cluster_uuid }}'
+;
+```
+</TabItem>
+
+<TabItem value="required">
+
 ```sql
 /*+ create */
 INSERT INTO digitalocean.databases.logsinks (
@@ -84,6 +103,30 @@ SELECT
   props:
     - name: database_cluster_uuid
       value: string
+    - name: sink_name
+      value: string
+    - name: sink_type
+      value: string
+    - name: config
+      props:
+        - name: server
+          value: string
+        - name: port
+          value: integer
+        - name: tls
+          value: boolean
+        - name: format
+          value: string
+        - name: logline
+          value: string
+        - name: sd
+          value: string
+        - name: ca
+          value: string
+        - name: key
+          value: string
+        - name: cert
+          value: string
 
 ```
 </TabItem>

diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/replicas/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/replicas/index.md
@@ -79,7 +79,7 @@ Use the following StackQL query and manifest file to create a new <code>replicas
 <Tabs
     defaultValue="all"
     values={[
-
+        { label: 'Required Properties', value: 'required' },
         { label: 'All Properties', value: 'all', },
         { label: 'Manifest', value: 'manifest', },
     ]
@@ -89,12 +89,37 @@ Use the following StackQL query and manifest file to create a new <code>replicas
 ```sql
 /*+ create */
 INSERT INTO digitalocean.databases.replicas (
-database_cluster_uuid,
-data__name
+data__name,
+data__region,
+data__size,
+data__tags,
+data__private_network_uuid,
+data__storage_size_mib,
+database_cluster_uuid
 )
 SELECT 
-'{{ database_cluster_uuid }}',
-'{{ name }}'
+'{{ name }}',
+'{{ region }}',
+'{{ size }}',
+'{{ tags }}',
+'{{ private_network_uuid }}',
+'{{ storage_size_mib }}',
+'{{ database_cluster_uuid }}'
+;
+```
+</TabItem>
+
+<TabItem value="required">
+
+```sql
+/*+ create */
+INSERT INTO digitalocean.databases.replicas (
+data__name,
+database_cluster_uuid
+)
+SELECT 
+'{{ name }}',
+'{{ database_cluster_uuid }}'
 ;
 ```
 </TabItem>
@@ -108,6 +133,18 @@ SELECT
       value: string
     - name: data__name
       value: string
+    - name: name
+      value: string
+    - name: region
+      value: string
+    - name: size
+      value: string
+    - name: tags
+      value: array
+    - name: private_network_uuid
+      value: string
+    - name: storage_size_mib
+      value: integer
 
 ```
 </TabItem>

diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/topics/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/topics/index.md
@@ -59,13 +59,34 @@ Use the following StackQL query and manifest file to create a new <code>topics</
 <Tabs
     defaultValue="all"
     values={[
-
+        { label: 'Required Properties', value: 'required' },
         { label: 'All Properties', value: 'all', },
         { label: 'Manifest', value: 'manifest', },
     ]
 }>
 <TabItem value="all">
 
+```sql
+/*+ create */
+INSERT INTO digitalocean.databases.topics (
+data__name,
+data__replication_factor,
+data__partition_count,
+data__config,
+database_cluster_uuid
+)
+SELECT 
+'{{ name }}',
+'{{ replication_factor }}',
+'{{ partition_count }}',
+'{{ config }}',
+'{{ database_cluster_uuid }}'
+;
+```
+</TabItem>
+
+<TabItem value="required">
+
 ```sql
 /*+ create */
 INSERT INTO digitalocean.databases.topics (
@@ -84,6 +105,56 @@ SELECT
   props:
     - name: database_cluster_uuid
       value: string
+    - name: name
+      value: string
+    - name: replication_factor
+      value: integer
+    - name: partition_count
+      value: integer
+    - name: config
+      props:
+        - name: cleanup_policy
+          value: string
+        - name: compression_type
+          value: string
+        - name: delete_retention_ms
+          value: integer
+        - name: file_delete_delay_ms
+          value: integer
+        - name: flush_messages
+          value: integer
+        - name: flush_ms
+          value: integer
+        - name: index_interval_bytes
+          value: integer
+        - name: max_compaction_lag_ms
+          value: integer
+        - name: max_message_bytes
+          value: integer
+        - name: message_down_conversion_enable
+          value: boolean
+        - name: message_format_version
+          value: string
+        - name: message_timestamp_type
+          value: string
+        - name: min_cleanable_dirty_ratio
+          value: number
+        - name: min_compaction_lag_ms
+          value: integer
+        - name: min_insync_replicas
+          value: integer
+        - name: preallocate
+          value: boolean
+        - name: retention_bytes
+          value: integer
+        - name: retention_ms
+          value: integer
+        - name: segment_bytes
+          value: integer
+        - name: segment_jitter_ms
+          value: integer
+        - name: segment_ms
+          value: integer
 
 ```
 </TabItem>

diff --git a/docs/digitalocean-docs/providers/digitalocean/databases/users/index.md b/docs/digitalocean-docs/providers/digitalocean/databases/users/index.md
@@ -82,14 +82,16 @@ Use the following StackQL query and manifest file to create a new <code>users</c
 ```sql
 /*+ create */
 INSERT INTO digitalocean.databases.users (
-data__readonly,
-database_cluster_uuid,
-data__name
+data__name,
+data__mysql_settings,
+data__settings,
+database_cluster_uuid
 )
 SELECT 
-'{{ readonly }}',
-'{{ database_cluster_uuid }}',
-'{{ name }}'
+'{{ name }}',
+'{{ mysql_settings }}',
+'{{ settings }}',
+'{{ database_cluster_uuid }}'
 ;
 ```
 </TabItem>
@@ -118,8 +120,32 @@ SELECT
       value: string
     - name: data__name
       value: string
-    - name: readonly
-      value: boolean
+    - name: name
+      value: string
+    - name: mysql_settings
+      props:
+        - name: auth_plugin
+          value: string
+    - name: settings
+      props:
+        - name: pg_allow_replication
+          value: boolean
+        - name: opensearch_acl
+          value: array
+          props:
+            - name: index
+              value: string
+            - name: permission
+              value: string
+        - name: acl
+          value: array
+          props:
+            - name: id
+              value: string
+            - name: topic
+              value: string
+            - name: permission
+              value: string
 
 ```
 </TabItem>