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

confluent updates
stackql · Nov 11, 2024 · 6302c5e · 6302c5e
2 parents 08a769b + 9a57a5f
commit 6302c5e
Show file tree

Hide file tree

Showing 57 changed files with 556 additions and 60 deletions.
diff --git a/docs/confluent-docs/providers/confluent/catalog/business_metadata/index.md b/docs/confluent-docs/providers/confluent/catalog/business_metadata/index.md
@@ -67,6 +67,7 @@ Use the following StackQL query and manifest file to create a new <code>business
 <Tabs
     defaultValue="all"
     values={[
+
         { label: 'All Properties', value: 'all', },
         { label: 'Manifest', value: 'manifest', },
     ]
@@ -83,6 +84,7 @@ SELECT
 ;
 ```
 </TabItem>
+
 <TabItem value="manifest">
 
 ```yaml

diff --git a/docs/confluent-docs/providers/confluent/catalog/business_metadata_defs/index.md b/docs/confluent-docs/providers/confluent/catalog/business_metadata_defs/index.md
@@ -83,6 +83,7 @@ Use the following StackQL query and manifest file to create a new <code>business
 <Tabs
     defaultValue="all"
     values={[
+
         { label: 'All Properties', value: 'all', },
         { label: 'Manifest', value: 'manifest', },
     ]
@@ -99,6 +100,7 @@ SELECT
 ;
 ```
 </TabItem>
+
 <TabItem value="manifest">
 
 ```yaml

diff --git a/docs/confluent-docs/providers/confluent/catalog/tag_defs/index.md b/docs/confluent-docs/providers/confluent/catalog/tag_defs/index.md
@@ -89,6 +89,7 @@ Use the following StackQL query and manifest file to create a new <code>tag_defs
 <Tabs
     defaultValue="all"
     values={[
+
         { label: 'All Properties', value: 'all', },
         { label: 'Manifest', value: 'manifest', },
     ]
@@ -105,6 +106,7 @@ SELECT
 ;
 ```
 </TabItem>
+
 <TabItem value="manifest">
 
 ```yaml

diff --git a/docs/confluent-docs/providers/confluent/catalog/tags/index.md b/docs/confluent-docs/providers/confluent/catalog/tags/index.md
@@ -77,6 +77,7 @@ Use the following StackQL query and manifest file to create a new <code>tags</co
 <Tabs
     defaultValue="all"
     values={[
+
         { label: 'All Properties', value: 'all', },
         { label: 'Manifest', value: 'manifest', },
     ]
@@ -93,6 +94,7 @@ SELECT
 ;
 ```
 </TabItem>
+
 <TabItem value="manifest">
 
 ```yaml

diff --git a/docs/confluent-docs/providers/confluent/connect/connector_config/index.md b/docs/confluent-docs/providers/confluent/connect/connector_config/index.md
@@ -72,6 +72,7 @@ Use the following StackQL query and manifest file to create a new <code>connecto
 <Tabs
     defaultValue="all"
     values={[
+        { label: 'Required Properties', value: 'required' },
         { label: 'All Properties', value: 'all', },
         { label: 'Manifest', value: 'manifest', },
     ]
@@ -85,6 +86,10 @@ data__connector.class,
 data__name,
 data__kafka.api.key,
 data__kafka.api.secret,
+data__confluent.connector.type,
+data__confluent.custom.plugin.id,
+data__confluent.custom.connection.endpoints,
+data__confluent.custom.schema.registry.auto,
 connector_name,
 environment_id,
 kafka_cluster_id
@@ -94,16 +99,42 @@ SELECT
 '{{ name }}',
 '{{ kafka.api.key }}',
 '{{ kafka.api.secret }}',
+'{{ confluent.connector.type }}',
+'{{ confluent.custom.plugin.id }}',
+'{{ confluent.custom.connection.endpoints }}',
+'{{ confluent.custom.schema.registry.auto }}',
 '{{ connector_name }}',
 '{{ environment_id }}',
-'{{ kafka_cluster_id }}',
-'{{ data__connector.class }}',
-'{{ data__kafka.api.key }}',
-'{{ data__kafka.api.secret }}',
-'{{ data__name }}'
+'{{ kafka_cluster_id }}'
 ;
 ```
 </TabItem>
+
+    <TabItem value="required">
+
+    ```sql
+    /*+ create */
+    INSERT INTO confluent.connect.connector_config (
+    data__connector.class,
+data__name,
+data__kafka.api.key,
+data__kafka.api.secret,
+connector_name,
+environment_id,
+kafka_cluster_id
+    )
+    SELECT 
+    '{{ connector.class }}',
+'{{ name }}',
+'{{ kafka.api.key }}',
+'{{ kafka.api.secret }}',
+'{{ connector_name }}',
+'{{ environment_id }}',
+'{{ kafka_cluster_id }}'
+    ;
+    ```
+    </TabItem>
+
 <TabItem value="manifest">
 
 ```yaml

diff --git a/docs/confluent-docs/providers/confluent/connect/connectors/index.md b/docs/confluent-docs/providers/confluent/connect/connectors/index.md
@@ -67,6 +67,7 @@ Use the following StackQL query and manifest file to create a new <code>connecto
 <Tabs
     defaultValue="all"
     values={[
+        { label: 'Required Properties', value: 'required' },
         { label: 'All Properties', value: 'all', },
         { label: 'Manifest', value: 'manifest', },
     ]
@@ -76,15 +77,37 @@ Use the following StackQL query and manifest file to create a new <code>connecto
 ```sql
 /*+ create */
 INSERT INTO confluent.connect.connectors (
+data__name,
+data__config,
+data__offsets,
 environment_id,
 kafka_cluster_id
 )
 SELECT 
+'{{ name }}',
+'{{ config }}',
+'{{ offsets }}',
 '{{ environment_id }}',
 '{{ kafka_cluster_id }}'
 ;
 ```
 </TabItem>
+
+    <TabItem value="required">
+
+    ```sql
+    /*+ create */
+    INSERT INTO confluent.connect.connectors (
+    environment_id,
+kafka_cluster_id
+    )
+    SELECT 
+    '{{ environment_id }}',
+'{{ kafka_cluster_id }}'
+    ;
+    ```
+    </TabItem>
+
 <TabItem value="manifest">
 
 ```yaml

diff --git a/docs/confluent-docs/providers/confluent/connect/custom_connector_plugins/index.md b/docs/confluent-docs/providers/confluent/connect/custom_connector_plugins/index.md
@@ -83,6 +83,7 @@ Use the following StackQL query and manifest file to create a new <code>custom_c
 <Tabs
     defaultValue="all"
     values={[
+        { label: 'Required Properties', value: 'required' },
         { label: 'All Properties', value: 'all', },
         { label: 'Manifest', value: 'manifest', },
     ]
@@ -93,18 +94,46 @@ Use the following StackQL query and manifest file to create a new <code>custom_c
 /*+ create */
 INSERT INTO confluent.connect.custom_connector_plugins (
 data__display_name,
+data__description,
+data__documentation_link,
 data__connector_class,
 data__connector_type,
+data__cloud,
+data__sensitive_config_properties,
 data__upload_source
 )
 SELECT 
 '{{ display_name }}',
+'{{ description }}',
+'{{ documentation_link }}',
 '{{ connector_class }}',
 '{{ connector_type }}',
+'{{ cloud }}',
+'{{ sensitive_config_properties }}',
 '{{ upload_source }}'
 ;
 ```
 </TabItem>
+
+    <TabItem value="required">
+
+    ```sql
+    /*+ create */
+    INSERT INTO confluent.connect.custom_connector_plugins (
+    data__display_name,
+data__connector_class,
+data__connector_type,
+data__upload_source
+    )
+    SELECT 
+    '{{ display_name }}',
+'{{ connector_class }}',
+'{{ connector_type }}',
+'{{ upload_source }}'
+    ;
+    ```
+    </TabItem>
+
 <TabItem value="manifest">
 
 ```yaml
@@ -143,7 +172,11 @@ Updates a <code>custom_connector_plugins</code> resource.
 /*+ update */
 UPDATE confluent.connect.custom_connector_plugins
 SET 
-
+display_name = '{{ display_name }}',
+description = '{{ description }}',
+documentation_link = '{{ documentation_link }}',
+sensitive_config_properties = '{{ sensitive_config_properties }}',
+upload_source = '{{ upload_source }}'
 WHERE 
 id = '{{ id }}';
 ```

diff --git a/...onfluent-docs/providers/confluent/encryption_keys/data_encryption_keys/index.md b/...onfluent-docs/providers/confluent/encryption_keys/data_encryption_keys/index.md
@@ -73,6 +73,7 @@ Use the following StackQL query and manifest file to create a new <code>data_enc
 <Tabs
     defaultValue="all"
     values={[
+        { label: 'Required Properties', value: 'required' },
         { label: 'All Properties', value: 'all', },
         { label: 'Manifest', value: 'manifest', },
     ]
@@ -82,13 +83,37 @@ Use the following StackQL query and manifest file to create a new <code>data_enc
 ```sql
 /*+ create */
 INSERT INTO confluent.encryption_keys.data_encryption_keys (
+data__subject,
+data__version,
+data__algorithm,
+data__encryptedKeyMaterial,
+data__deleted,
 name
 )
 SELECT 
+'{{ subject }}',
+'{{ version }}',
+'{{ algorithm }}',
+'{{ encryptedKeyMaterial }}',
+'{{ deleted }}',
 '{{ name }}'
 ;
 ```
 </TabItem>
+
+    <TabItem value="required">
+
+    ```sql
+    /*+ create */
+    INSERT INTO confluent.encryption_keys.data_encryption_keys (
+    name
+    )
+    SELECT 
+    '{{ name }}'
+    ;
+    ```
+    </TabItem>
+
 <TabItem value="manifest">
 
 ```yaml

diff --git a/...confluent-docs/providers/confluent/encryption_keys/key_encryption_keys/index.md b/...confluent-docs/providers/confluent/encryption_keys/key_encryption_keys/index.md
@@ -74,6 +74,7 @@ Use the following StackQL query and manifest file to create a new <code>key_encr
 <Tabs
     defaultValue="all"
     values={[
+
         { label: 'All Properties', value: 'all', },
         { label: 'Manifest', value: 'manifest', },
     ]
@@ -83,13 +84,26 @@ Use the following StackQL query and manifest file to create a new <code>key_encr
 ```sql
 /*+ create */
 INSERT INTO confluent.encryption_keys.key_encryption_keys (
-
+data__name,
+data__kmsType,
+data__kmsKeyId,
+data__kmsProps,
+data__doc,
+data__shared,
+data__deleted
 )
 SELECT 
-
+'{{ name }}',
+'{{ kmsType }}',
+'{{ kmsKeyId }}',
+'{{ kmsProps }}',
+'{{ doc }}',
+'{{ shared }}',
+'{{ deleted }}'
 ;
 ```
 </TabItem>
+
 <TabItem value="manifest">
 
 ```yaml
@@ -122,7 +136,9 @@ Replaces all fields in the specified <code>key_encryption_keys</code> resource.
 /*+ update */
 REPLACE confluent.encryption_keys.key_encryption_keys
 SET 
-
+kmsProps = '{{ kmsProps }}',
+doc = '{{ doc }}',
+shared = true|false
 WHERE 
 name = '{{ name }}';
 ```

diff --git a/docs/confluent-docs/providers/confluent/encryption_keys/keys/index.md b/docs/confluent-docs/providers/confluent/encryption_keys/keys/index.md
@@ -70,6 +70,7 @@ Use the following StackQL query and manifest file to create a new <code>keys</co
 <Tabs
     defaultValue="all"
     values={[
+
         { label: 'All Properties', value: 'all', },
         { label: 'Manifest', value: 'manifest', },
     ]
@@ -86,6 +87,7 @@ SELECT
 ;
 ```
 </TabItem>
+
 <TabItem value="manifest">
 
 ```yaml