Skip to content

doc updates #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeffreyaven merged 1 commit into from
Sep 12, 2025
Merged

doc updates #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
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.4"
"@stackql/provider-utils": "^0.4.8"
},
"keywords": [
"stackql",
Expand Down
3 changes: 2 additions & 1 deletion website/docs/services/account/account/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,8 @@ status,
status_message,
team,
uuid
FROM digitalocean.account.account;
FROM digitalocean.account.account
;
```
</TabItem>
</Tabs>
6 changes: 4 additions & 2 deletions website/docs/services/account/actions/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,8 @@ started_at,
status,
type
FROM digitalocean.account.actions
WHERE action_id = '{{ action_id }}' -- required;
WHERE action_id = '{{ action_id }}' -- required
;
```
</TabItem>
<TabItem value="actions_list">
Expand All @@ -270,7 +271,8 @@ status,
type
FROM digitalocean.account.actions
WHERE per_page = '{{ per_page }}'
AND page = '{{ page }}';
AND page = '{{ page }}'
;
```
</TabItem>
</Tabs>
3 changes: 2 additions & 1 deletion website/docs/services/apps/alerts/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,8 @@ progress,
slack_webhooks,
spec
FROM digitalocean.apps.alerts
WHERE app_id = '{{ app_id }}' -- required;
WHERE app_id = '{{ app_id }}' -- required
;
```
</TabItem>
</Tabs>
20 changes: 13 additions & 7 deletions website/docs/services/apps/apps/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,8 @@ updated_at,
vpc
FROM digitalocean.apps.apps
WHERE id = '{{ id }}' -- required
AND name = '{{ name }}';
AND name = '{{ name }}'
;
```
</TabItem>
<TabItem value="apps_list">
Expand Down Expand Up @@ -476,7 +477,8 @@ vpc
FROM digitalocean.apps.apps
WHERE page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND with_projects = '{{ with_projects }}';
AND with_projects = '{{ with_projects }}'
;
```
</TabItem>
</Tabs>
Expand All @@ -503,7 +505,7 @@ Accept,
Content-Type
)
SELECT
'{{ spec }}' --required,
'{{ spec }}' /* required */,
'{{ project_id }}',
'{{ Accept }}',
'{{ Content-Type }}'
Expand Down Expand Up @@ -581,7 +583,8 @@ Delete an existing app. Once deleted, all active deployments will be permanently

```sql
DELETE FROM digitalocean.apps.apps
WHERE id = '{{ id }}' --required;
WHERE id = '{{ id }}' --required
;
```
</TabItem>
</Tabs>
Expand All @@ -607,7 +610,8 @@ EXEC digitalocean.apps.apps.apps_restart
@@json=
'{
"components": "{{ components }}"
}';
}'
;
```
</TabItem>
<TabItem value="apps_validate_app_spec">
Expand All @@ -620,7 +624,8 @@ EXEC digitalocean.apps.apps.apps_validate_app_spec
'{
"spec": "{{ spec }}",
"app_id": "{{ app_id }}"
}';
}'
;
```
</TabItem>
<TabItem value="apps_assign_alert_destinations">
Expand All @@ -635,7 +640,8 @@ EXEC digitalocean.apps.apps.apps_assign_alert_destinations
'{
"emails": "{{ emails }}",
"slack_webhooks": "{{ slack_webhooks }}"
}';
}'
;
```
</TabItem>
</Tabs>
5 changes: 3 additions & 2 deletions website/docs/services/apps/daily_bandwidth_metrics/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,8 @@ app_bandwidth_usage,
date
FROM digitalocean.apps.daily_bandwidth_metrics
WHERE app_id = '{{ app_id }}' -- required
AND date = '{{ date }}';
AND date = '{{ date }}'
;
```
</TabItem>
</Tabs>
Expand All @@ -166,7 +167,7 @@ data__app_ids,
data__date
)
SELECT
'{{ app_ids }}' --required,
'{{ app_ids }}' /* required */,
'{{ date }}'
RETURNING
app_bandwidth_usage,
Expand Down
12 changes: 8 additions & 4 deletions website/docs/services/apps/deployment_logs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,8 @@ AND deployment_id = '{{ deployment_id }}' -- required
AND component_name = '{{ component_name }}' -- required
AND type = '{{ type }}' -- required
AND follow = '{{ follow }}'
AND pod_connection_timeout = '{{ pod_connection_timeout }}';
AND pod_connection_timeout = '{{ pod_connection_timeout }}'
;
```
</TabItem>
<TabItem value="apps_get_logs_active_deployment">
Expand All @@ -279,7 +280,8 @@ WHERE app_id = '{{ app_id }}' -- required
AND component_name = '{{ component_name }}' -- required
AND type = '{{ type }}' -- required
AND follow = '{{ follow }}'
AND pod_connection_timeout = '{{ pod_connection_timeout }}';
AND pod_connection_timeout = '{{ pod_connection_timeout }}'
;
```
</TabItem>
<TabItem value="apps_get_logs_aggregate">
Expand All @@ -295,7 +297,8 @@ WHERE app_id = '{{ app_id }}' -- required
AND deployment_id = '{{ deployment_id }}' -- required
AND type = '{{ type }}' -- required
AND follow = '{{ follow }}'
AND pod_connection_timeout = '{{ pod_connection_timeout }}';
AND pod_connection_timeout = '{{ pod_connection_timeout }}'
;
```
</TabItem>
<TabItem value="apps_get_logs_active_deployment_aggregate">
Expand All @@ -310,7 +313,8 @@ FROM digitalocean.apps.deployment_logs
WHERE app_id = '{{ app_id }}' -- required
AND type = '{{ type }}' -- required
AND follow = '{{ follow }}'
AND pod_connection_timeout = '{{ pod_connection_timeout }}';
AND pod_connection_timeout = '{{ pod_connection_timeout }}'
;
```
</TabItem>
</Tabs>
6 changes: 4 additions & 2 deletions website/docs/services/apps/deployment_url/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,8 @@ FROM digitalocean.apps.deployment_url
WHERE app_id = '{{ app_id }}' -- required
AND deployment_id = '{{ deployment_id }}' -- required
AND component_name = '{{ component_name }}' -- required
AND instance_name = '{{ instance_name }}';
AND instance_name = '{{ instance_name }}'
;
```
</TabItem>
<TabItem value="apps_get_exec_active_deployment">
Expand All @@ -183,7 +184,8 @@ url
FROM digitalocean.apps.deployment_url
WHERE app_id = '{{ app_id }}' -- required
AND component_name = '{{ component_name }}' -- required
AND instance_name = '{{ instance_name }}';
AND instance_name = '{{ instance_name }}'
;
```
</TabItem>
</Tabs>
9 changes: 6 additions & 3 deletions website/docs/services/apps/deployments/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,8 @@ updated_at,
workers
FROM digitalocean.apps.deployments
WHERE app_id = '{{ app_id }}' -- required
AND deployment_id = '{{ deployment_id }}' -- required;
AND deployment_id = '{{ deployment_id }}' -- required
;
```
</TabItem>
<TabItem value="apps_list_deployments">
Expand Down Expand Up @@ -369,7 +370,8 @@ FROM digitalocean.apps.deployments
WHERE app_id = '{{ app_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND deployment_types = '{{ deployment_types }}';
AND deployment_types = '{{ deployment_types }}'
;
```
</TabItem>
</Tabs>
Expand Down Expand Up @@ -432,7 +434,8 @@ Immediately cancel an in-progress deployment.
```sql
EXEC digitalocean.apps.deployments.apps_cancel_deployment
@app_id='{{ app_id }}' --required,
@deployment_id='{{ deployment_id }}' --required;
@deployment_id='{{ deployment_id }}' --required
;
```
</TabItem>
</Tabs>
3 changes: 2 additions & 1 deletion website/docs/services/apps/health/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,8 @@ SELECT
components,
functions_components
FROM digitalocean.apps.health
WHERE app_id = '{{ app_id }}' -- required;
WHERE app_id = '{{ app_id }}' -- required
;
```
</TabItem>
</Tabs>
6 changes: 4 additions & 2 deletions website/docs/services/apps/instance_sizes/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,8 @@ tier_upgrade_to,
usd_per_month,
usd_per_second
FROM digitalocean.apps.instance_sizes
WHERE slug = '{{ slug }}' -- required;
WHERE slug = '{{ slug }}' -- required
;
```
</TabItem>
<TabItem value="apps_list_instance_sizes">
Expand All @@ -246,7 +247,8 @@ List all instance sizes for `service`, `worker`, and `job` components.
SELECT
discount_percent,
instance_sizes
FROM digitalocean.apps.instance_sizes;
FROM digitalocean.apps.instance_sizes
;
```
</TabItem>
</Tabs>
3 changes: 2 additions & 1 deletion website/docs/services/apps/instances/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,8 @@ instance_name,
component_type,
instance_alias
FROM digitalocean.apps.instances
WHERE app_id = '{{ app_id }}' -- required;
WHERE app_id = '{{ app_id }}' -- required
;
```
</TabItem>
</Tabs>
3 changes: 2 additions & 1 deletion website/docs/services/apps/regions/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,8 @@ flag,
label,
reason,
slug
FROM digitalocean.apps.regions;
FROM digitalocean.apps.regions
;
```
</TabItem>
</Tabs>
9 changes: 6 additions & 3 deletions website/docs/services/apps/rollbacks/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,8 @@ EXEC digitalocean.apps.rollbacks.apps_validate_rollback
'{
"deployment_id": "{{ deployment_id }}",
"skip_pin": {{ skip_pin }}
}';
}'
;
```
</TabItem>
<TabItem value="apps_commit_rollback">
Expand All @@ -183,7 +184,8 @@ Commit an app rollback. This action permanently applies the rollback and unpins

```sql
EXEC digitalocean.apps.rollbacks.apps_commit_rollback
@app_id='{{ app_id }}' --required;
@app_id='{{ app_id }}' --required
;
```
</TabItem>
<TabItem value="apps_revert_rollback">
Expand All @@ -192,7 +194,8 @@ Revert an app rollback. This action reverts the active rollback by creating a ne

```sql
EXEC digitalocean.apps.rollbacks.apps_revert_rollback
@app_id='{{ app_id }}' --required;
@app_id='{{ app_id }}' --required
;
```
</TabItem>
</Tabs>
3 changes: 2 additions & 1 deletion website/docs/services/billing/balances/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,8 @@ account_balance,
generated_at,
month_to_date_balance,
month_to_date_usage
FROM digitalocean.billing.balances;
FROM digitalocean.billing.balances
;
```
</TabItem>
</Tabs>
3 changes: 2 additions & 1 deletion website/docs/services/billing/billing_history/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,8 @@ date,
description,
invoice_uuid,
type
FROM digitalocean.billing.billing_history;
FROM digitalocean.billing.billing_history
;
```
</TabItem>
</Tabs>
3 changes: 2 additions & 1 deletion website/docs/services/billing/invoice_summary/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,8 @@ user_billing_address,
user_company,
user_email
FROM digitalocean.billing.invoice_summary
WHERE invoice_uuid = '{{ invoice_uuid }}' -- required;
WHERE invoice_uuid = '{{ invoice_uuid }}' -- required
;
```
</TabItem>
</Tabs>
12 changes: 8 additions & 4 deletions website/docs/services/billing/invoices/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,8 @@ start_time
FROM digitalocean.billing.invoices
WHERE invoice_uuid = '{{ invoice_uuid }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}';
AND page = '{{ page }}'
;
```
</TabItem>
<TabItem value="invoices_list">
Expand All @@ -268,7 +269,8 @@ links,
meta
FROM digitalocean.billing.invoices
WHERE per_page = '{{ per_page }}'
AND page = '{{ page }}';
AND page = '{{ page }}'
;
```
</TabItem>
</Tabs>
Expand All @@ -289,7 +291,8 @@ To retrieve a CSV for an invoice, send a GET request to `/v2/customers/my/invoic

```sql
EXEC digitalocean.billing.invoices.invoices_get_csv_by_uuid
@invoice_uuid='{{ invoice_uuid }}' --required;
@invoice_uuid='{{ invoice_uuid }}' --required
;
```
</TabItem>
<TabItem value="invoices_get_pdf_by_uuid">
Expand All @@ -298,7 +301,8 @@ To retrieve a PDF for an invoice, send a GET request to `/v2/customers/my/invoic

```sql
EXEC digitalocean.billing.invoices.invoices_get_pdf_by_uuid
@invoice_uuid='{{ invoice_uuid }}' --required;
@invoice_uuid='{{ invoice_uuid }}' --required
;
```
</TabItem>
</Tabs>
Loading
Loading