Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
360 changes: 178 additions & 182 deletions README.md

Large diffs are not rendered by default.

527 changes: 527 additions & 0 deletions package-lock.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
},
"dependencies": {
"@stackql/pgwire-lite": "^1.0.1",
"@stackql/provider-utils": "^0.4.6"
"@stackql/provider-utils": "^0.5.0"
},
"keywords": [
"stackql",
Expand Down
Empty file removed website/docs/.gitkeep
Empty file.
108 changes: 108 additions & 0 deletions website/docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
---
title: confluent
hide_title: false
hide_table_of_contents: false
keywords:
- confluent
- kafka
- stackql
- infrastructure-as-code
- configuration-as-data
- cloud inventory
description: Query, deploy and manage Confluent Cloud resources using SQL
custom_edit_url: null
image: /img/stackql-confluent-provider-featured-image.png
id: 'provider-intro'
---

import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';

Confluent Cloud for managing Kafka clusters, topics, and streaming services in a scalable cloud environment.


:::info Provider Summary

<div class="row">
<div class="providerDocColumn">
<span>total services:&nbsp;<b>22</b></span><br />
<span>total resources:&nbsp;<b>132</b></span><br />
</div>
</div>

:::

See also:
[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry)
* * *

## Installation

To pull the latest version of the `confluent` provider, run the following command:

```bash
REGISTRY PULL confluent;
```
> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry).

## Authentication

The following system environment variables are used for authentication by default:

- <CopyableCode code="CONFLUENT_CLOUD_API_KEY" /> - Confluent Cloud API key (see <a href="https://docs.confluent.io/cloud/current/security/authenticate/overview.html#api-keys">Confluent Cloud API Keys</a>)
- <CopyableCode code="CONFLUENT_CLOUD_API_SECRET" /> - Confluent Cloud API secret (see <a href="https://docs.confluent.io/cloud/current/security/authenticate/overview.html#api-keys">Confluent Cloud API Keys</a>)

These variables are sourced at runtime (from the local machine or as CI variables/secrets).

<details>

<summary>Using different environment variables</summary>

To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example:

```bash

AUTH='{ "confluent": { "type": "basic", "username_var": "MY_CONFLUENT_CLOUD_API_KEY_VAR", "password_var": "MY_CONFLUENT_CLOUD_API_SECRET_VAR" }}'
stackql shell --auth="${AUTH}"

```

or using PowerShell:

```powershell

$Auth = "{ 'confluent': { 'type': 'basic', 'username_var': 'MY_CONFLUENT_CLOUD_API_KEY_VAR', 'password_var': 'MY_CONFLUENT_CLOUD_API_SECRET_VAR' }}"
stackql.exe shell --auth=$Auth

```
</details>


## Services
<div class="row">
<div class="providerDocColumn">
<a href="/services/billing/">billing</a><br />
<a href="/services/catalog/">catalog</a><br />
<a href="/services/connect/">connect</a><br />
<a href="/services/encryption_keys/">encryption_keys</a><br />
<a href="/services/flink_artifacts/">flink_artifacts</a><br />
<a href="/services/flink_compute_pools/">flink_compute_pools</a><br />
<a href="/services/iam/">iam</a><br />
<a href="/services/kafka/">kafka</a><br />
<a href="/services/ksqldb_clusters/">ksqldb_clusters</a><br />
<a href="/services/managed_kafka_clusters/">managed_kafka_clusters</a><br />
<a href="/services/networking/">networking</a><br />
</div>
<div class="providerDocColumn">
<a href="/services/notifications/">notifications</a><br />
<a href="/services/org/">org</a><br />
<a href="/services/partner/">partner</a><br />
<a href="/services/pipelines/">pipelines</a><br />
<a href="/services/provider_integrations/">provider_integrations</a><br />
<a href="/services/quotas/">quotas</a><br />
<a href="/services/schema_registry/">schema_registry</a><br />
<a href="/services/schema_registry_clusters/">schema_registry_clusters</a><br />
<a href="/services/sql/">sql</a><br />
<a href="/services/stream_sharing/">stream_sharing</a><br />
<a href="/services/sts/">sts</a><br />
</div>
</div>
81 changes: 81 additions & 0 deletions website/docs/services/billing/costs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
---
title: costs
hide_title: false
hide_table_of_contents: false
keywords:
- costs
- billing
- confluent
- infrastructure-as-code
- configuration-as-data
- cloud inventory
description: Query, deploy and manage confluent resources using SQL
custom_edit_url: null
image: /img/stackql-confluent-provider-featured-image.png
---

import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Creates, updates, deletes, gets or lists a <code>costs</code> resource.

## Overview
<table><tbody>
<tr><td><b>Name</b></td><td><code>costs</code></td></tr>
<tr><td><b>Type</b></td><td>Resource</td></tr>
<tr><td><b>Id</b></td><td><CopyableCode code="confluent.billing.costs" /></td></tr>
</tbody></table>

## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
| <CopyableCode code="id" /> | `string` | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). |
| <CopyableCode code="amount" /> | `number` | Final amount after deducting discounts. |
| <CopyableCode code="api_version" /> | `string` | APIVersion defines the schema version of this representation of a resource. |
| <CopyableCode code="discount_amount" /> | `number` | Amount discounted from the original amount in dollars. |
| <CopyableCode code="end_date" /> | `string` | End date of time period (exclusive) to retrieve billing costs. It is represented in RFC3339 format and is in UTC. |
| <CopyableCode code="granularity" /> | `string` | Granularity at which each line item is aggregated. |
| <CopyableCode code="kind" /> | `string` | Kind defines the object this REST resource represents. |
| <CopyableCode code="line_type" /> | `string` | Type of the line item. |
| <CopyableCode code="network_access_type" /> | `string` | Network access type for the cluster. |
| <CopyableCode code="original_amount" /> | `number` | Original amount accrued for this line item. |
| <CopyableCode code="price" /> | `number` | Price for the line item in dollars. |
| <CopyableCode code="product" /> | `string` | Product name. |
| <CopyableCode code="quantity" /> | `number` | Quantity of the line item. |
| <CopyableCode code="resource" /> | `object` | The resource for a given object |
| <CopyableCode code="start_date" /> | `string` | Start date of time period (inclusive) to retrieve billing costs. It is represented in RFC3339 format and is in UTC. |
| <CopyableCode code="unit" /> | `string` | Unit of the line item. |

## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| <CopyableCode code="list_billing_v1costs" /> | `SELECT` | <CopyableCode code="end_date, start_date" /> | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all costs. |

## `SELECT` examples

[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all costs.


```sql
SELECT
id,
amount,
api_version,
discount_amount,
end_date,
granularity,
kind,
line_type,
network_access_type,
original_amount,
price,
product,
quantity,
resource,
start_date,
unit
FROM confluent.billing.costs
WHERE end_date = '{{ end_date }}'
AND start_date = '{{ start_date }}';
```
37 changes: 37 additions & 0 deletions website/docs/services/billing/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: billing
hide_title: false
hide_table_of_contents: false
keywords:
- billing
- confluent
- stackql
- infrastructure-as-code
- configuration-as-data
- cloud inventory
description: Query, deploy and manage confluent resources using SQL
custom_edit_url: null
image: /img/stackql-confluent-provider-featured-image.png
---

billing service documentation.

:::info Service Summary

<div class="row">
<div class="providerDocColumn">
<span>total resources:&nbsp;<b>1</b></span><br />
</div>
</div>

:::

## Resources
<div class="row">
<div class="providerDocColumn">
<a href="/services/billing/costs/">costs</a>
</div>
<div class="providerDocColumn">

</div>
</div>
108 changes: 108 additions & 0 deletions website/docs/services/catalog/business_metadata/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
---
title: business_metadata
hide_title: false
hide_table_of_contents: false
keywords:
- business_metadata
- catalog
- confluent
- infrastructure-as-code
- configuration-as-data
- cloud inventory
description: Query, deploy and manage confluent resources using SQL
custom_edit_url: null
image: /img/stackql-confluent-provider-featured-image.png
---

import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Creates, updates, deletes, gets or lists a <code>business_metadata</code> resource.

## Overview
<table><tbody>
<tr><td><b>Name</b></td><td><code>business_metadata</code></td></tr>
<tr><td><b>Type</b></td><td>Resource</td></tr>
<tr><td><b>Id</b></td><td><CopyableCode code="confluent.catalog.business_metadata" /></td></tr>
</tbody></table>

## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
| <CopyableCode code="attributes" /> | `object` | The business metadata attributes |
| <CopyableCode code="entityName" /> | `string` | The qualified name of the entity |
| <CopyableCode code="entityType" /> | `string` | The entity type |
| <CopyableCode code="error" /> | `object` | Error message of this operation |
| <CopyableCode code="typeName" /> | `string` | The business metadata name |

## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| <CopyableCode code="get_business_metadata" /> | `SELECT` | <CopyableCode code="qualifiedName, typeName" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Gets the list of business metadata for a given entity represented by a qualified name. |
| <CopyableCode code="create_business_metadata" /> | `INSERT` | <CopyableCode code="" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Bulk API to create multiple business metadata. |
| <CopyableCode code="delete_business_metadata" /> | `DELETE` | <CopyableCode code="bmName, qualifiedName, typeName" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Delete a business metadata on an entity. |
| <CopyableCode code="update_business_metadata" /> | `EXEC` | <CopyableCode code="" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Bulk API to update multiple business metadata. |

## `SELECT` examples

[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Gets the list of business metadata for a given entity represented by a qualified name.


```sql
SELECT
attributes,
entityName,
entityType,
error,
typeName
FROM confluent.catalog.business_metadata
WHERE qualifiedName = '{{ qualifiedName }}'
AND typeName = '{{ typeName }}';
```
## `INSERT` example

Use the following StackQL query and manifest file to create a new <code>business_metadata</code> resource.

<Tabs
defaultValue="all"
values={[

{ label: 'All Properties', value: 'all', },
{ label: 'Manifest', value: 'manifest', },
]
}>
<TabItem value="all">

```sql
/*+ create */
INSERT INTO confluent.catalog.business_metadata (

)
SELECT

;
```
</TabItem>

<TabItem value="manifest">

```yaml
- name: business_metadata
props: []

```
</TabItem>
</Tabs>

## `DELETE` example

Deletes the specified <code>business_metadata</code> resource.

```sql
/*+ delete */
DELETE FROM confluent.catalog.business_metadata
WHERE bmName = '{{ bmName }}'
AND qualifiedName = '{{ qualifiedName }}'
AND typeName = '{{ typeName }}';
```
Loading
Loading