Skip to content
Closed
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
1 change: 1 addition & 0 deletions docs/reference/cli/commands/ddn.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ ddn [flags]
## Available operations

- [ddn auth](/reference/cli/commands/ddn_auth) - Manage Hasura DDN CLI Auth
- [ddn changelog](/reference/cli/commands/ddn_changelog) - Manage changelogs for applied supergraph builds
- [ddn codemod](/reference/cli/commands/ddn_codemod) - Perform transformations on your Hasura project directory
- [ddn command](/reference/cli/commands/ddn_command) - Perform Command-related operations
- [ddn connector](/reference/cli/commands/ddn_connector) - Perform Connector related operations
Expand Down
45 changes: 45 additions & 0 deletions docs/reference/cli/commands/ddn_changelog.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
sidebar_label: ddn changelog
sidebar_position: 8
description: Manage changelogs for applied supergraph builds using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_changelog"
keywords:
- hasura
- DDN
- docs
- CLI
- ddn changelog
---

# DDN CLI: ddn changelog

Manage changelogs for applied supergraph builds.

## Synopsis

Manage changelogs for applied supergraph builds. Use this command to view and edit changelog entries for supergraph builds that have been applied to your project.

## Available operations

- [ddn changelog add](/reference/cli/commands/ddn_changelog_add) - Update version number for existing changelog entries
- [ddn changelog edit](/reference/cli/commands/ddn_changelog_edit) - Edit an existing changelog entry by version number
- [ddn changelog list](/reference/cli/commands/ddn_changelog_list) - Show all changelog entries for supergraph builds

## Options

```sass
-h, --help help for changelog
```

## Options inherited from parent operations

```sass
--log-level string Log level. Can be DEBUG, WARN, INFO, ERROR, or FATAL. (default "INFO")
--no-prompt Do not prompt for required but missing flags
--out string Output format. Can be table, json or yaml. (default "table")
--timeout int Request timeout in seconds [env: HASURA_DDN_TIMEOUT] (default 100)
```

## Parent operation

- [ddn](/reference/cli/commands/ddn) - DDN Command Line Interface
54 changes: 54 additions & 0 deletions docs/reference/cli/commands/ddn_changelog_add.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
sidebar_label: ddn changelog add
sidebar_position: 9
description: Update version number for existing changelog entries using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_changelog_add"
keywords:
- hasura
- DDN
- docs
- CLI
- ddn changelog add
---

# DDN CLI: ddn changelog add

Update version number for existing changelog entries.

## Synopsis

Update the version_number field for existing changelog entries associated with a specific build. This command is used for backfilling existing entries that predate the version numbering feature.

```bash
ddn changelog add <build-version> [flags]
```

## Examples

```bash
# Update version number for all changelog entries of a specific build
ddn changelog add abc123 --version-number 2025.02.23
```

## Options

```sass
--ci Disables the use of context
-c, --context string Name of the context to use. (default <current_context>)
-h, --help help for add
--project string Project name for the changelog entry
--version-number string Version number for the changelog entry in CalVer format (YYYY.MM.DD) (required)
```

## Options inherited from parent operations

```sass
--log-level string Log level. Can be DEBUG, WARN, INFO, ERROR, or FATAL. (default "INFO")
--no-prompt Do not prompt for required but missing flags
--out string Output format. Can be table, json or yaml. (default "table")
--timeout int Request timeout in seconds [env: HASURA_DDN_TIMEOUT] (default 100)
```

## Parent operation

- [ddn changelog](/reference/cli/commands/ddn_changelog) - Manage changelogs for applied supergraph builds
70 changes: 70 additions & 0 deletions docs/reference/cli/commands/ddn_changelog_edit.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
sidebar_label: ddn changelog edit
sidebar_position: 10
description: Edit an existing changelog entry by version number using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_changelog_edit"
keywords:
- hasura
- DDN
- docs
- CLI
- ddn changelog edit
---

# DDN CLI: ddn changelog edit

Edit an existing changelog entry by version number.

## Synopsis

Edit the changelog entry for a specific version. This command allows you to modify the changelog_body, publication status, and version_number in the ddn_applied_build_changelog table.

```bash
ddn changelog edit <version-number> [flags]
```

## Examples

```bash
# Edit changelog body in editor
ddn changelog edit v2025.02.23.1

# Set published status directly
ddn changelog edit v2025.02.23.1 --published true

# Update multiple fields at once
ddn changelog edit v2025.02.23.1 --changelog-body "New content" --published true

# Change version number
ddn changelog edit v2025.02.23.1 --version-number v2025.02.23.2

# Force editor even with other flags
ddn changelog edit v2025.02.23.1 --published true --editor
```

## Options

```sass
--changelog-body string Set changelog body content directly
--ci Disables the use of context
-c, --context string Name of the context to use. (default <current_context>)
--editor Open editor for changelog body (even if other flags are provided)
--editor-cmd string Specific editor command to use (defaults to $EDITOR environment variable)
-h, --help help for edit
--project string Project name for the changelog entry
--published string Set publication status (true/false)
--version-number string Update the version number
```

## Options inherited from parent operations

```sass
--log-level string Log level. Can be DEBUG, WARN, INFO, ERROR, or FATAL. (default "INFO")
--no-prompt Do not prompt for required but missing flags
--out string Output format. Can be table, json or yaml. (default "table")
--timeout int Request timeout in seconds [env: HASURA_DDN_TIMEOUT] (default 100)
```

## Parent operation

- [ddn changelog](/reference/cli/commands/ddn_changelog) - Manage changelogs for applied supergraph builds
61 changes: 61 additions & 0 deletions docs/reference/cli/commands/ddn_changelog_list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
sidebar_label: ddn changelog list
sidebar_position: 11
description: Show all changelog entries for supergraph builds using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_changelog_list"
keywords:
- hasura
- DDN
- docs
- CLI
- ddn changelog list
---

# DDN CLI: ddn changelog list

Show all changelog entries for supergraph builds.

## Synopsis

List all changelog entries for applied supergraph builds. This command retrieves changelog information from the ddn_applied_build_changelog table.

```bash
ddn changelog list [flags]
```

## Examples

```bash
# List all changelog entries for the current project
ddn changelog list

# List all changelog entries for a specific project
ddn changelog list --project my-project

# List changelog entries with pagination
ddn changelog list --limit 10 --offset 20
```

## Options

```sass
--ci Disables the use of context
-c, --context string Name of the context to use. (default <current_context>)
-h, --help help for list
--limit int Limit the number of changelog entries returned
--offset int Offset for pagination
--project string Project name to list changelogs for
```

## Options inherited from parent operations

```sass
--log-level string Log level. Can be DEBUG, WARN, INFO, ERROR, or FATAL. (default "INFO")
--no-prompt Do not prompt for required but missing flags
--out string Output format. Can be table, json or yaml. (default "table")
--timeout int Request timeout in seconds [env: HASURA_DDN_TIMEOUT] (default 100)
```

## Parent operation

- [ddn changelog](/reference/cli/commands/ddn_changelog) - Manage changelogs for applied supergraph builds
2 changes: 1 addition & 1 deletion docs/reference/cli/commands/ddn_codemod.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: ddn codemod
sidebar_position: 8
sidebar_position: 12
description: Perform transformations on your Hasura project directory using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod"
keywords:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: ddn codemod configure-header-forwarding
sidebar_position: 9
sidebar_position: 13
description: Configure headers to be forwarded to your connector using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod_configure-header-forwarding"
keywords:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: ddn codemod fix-traces-env-var
sidebar_position: 10
sidebar_position: 14
description: Fix env var used for configuring traces for connectors using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod_fix-traces-env-var"
keywords:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: ddn codemod rename-graphql-prefixes
sidebar_position: 11
sidebar_position: 15
description: Rename GraphQL root field and type name prefixes in metadata using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod_rename-graphql-prefixes"
keywords:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: ddn codemod upgrade-auth-config-to-v3
sidebar_position: 12
sidebar_position: 16
description: Upgrade AuthConfig version from "v1"/"v2" to "v3" using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod_upgrade-auth-config-to-v3"
keywords:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: ddn codemod upgrade-context-v2-to-v3
sidebar_position: 13
sidebar_position: 17
description: Upgrade project's context config from v2 to v3 using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod_upgrade-context-v2-to-v3"
keywords:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: ddn codemod upgrade-graphqlconfig-aggregate
sidebar_position: 14
sidebar_position: 18
description: Upgrade GraphqlConfig to support aggregates using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod_upgrade-graphqlconfig-aggregate"
keywords:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: ddn codemod upgrade-graphqlconfig-subscriptions
sidebar_position: 15
sidebar_position: 19
description: Upgrade GraphqlConfig to support subscriptions using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod_upgrade-graphqlconfig-subscriptions"
keywords:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: ddn codemod upgrade-model-v1-to-v2
sidebar_position: 16
sidebar_position: 20
description: Upgrade model from "version" "v1" to "v2" in metadata using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod_upgrade-model-v1-to-v2"
keywords:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: ddn codemod upgrade-object-boolean-expression-types
sidebar_position: 17
sidebar_position: 21
description: Upgrade object boolean expression types metadata using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod_upgrade-object-boolean-expression-types"
keywords:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: ddn codemod upgrade-project-config-v2-to-v3
sidebar_position: 18
sidebar_position: 22
description: Upgrade project directory from version v2 to v3 using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod_upgrade-project-config-v2-to-v3"
keywords:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: ddn codemod upgrade-supergraph-config-v1-to-v2
sidebar_position: 19
sidebar_position: 23
description: Upgrade all Supergraph config files at the root of the project directory from v1 to v2 using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod_upgrade-supergraph-config-v1-to-v2"
keywords:
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/commands/ddn_command.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: ddn command
sidebar_position: 20
sidebar_position: 24
description: Perform Command-related operations using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_command"
keywords:
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/commands/ddn_command_add.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: ddn command add
sidebar_position: 21
sidebar_position: 25
description: Add new Commands to the local metadata using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_command_add"
keywords:
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/commands/ddn_command_list.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: ddn command list
sidebar_position: 22
sidebar_position: 26
description: Lists details about the functions/procedures of DataConnectorLink, and their corresponding Commands using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_command_list"
keywords:
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/commands/ddn_command_remove.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: ddn command remove
sidebar_position: 23
sidebar_position: 27
description: Removes Commands (and related metadata) in the local metadata using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_command_remove"
keywords:
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/commands/ddn_command_show.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: ddn command show
sidebar_position: 24
sidebar_position: 28
description: Show diff between the command and its corresponding ndc function/procedure using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_command_show"
keywords:
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/commands/ddn_command_update.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: ddn command update
sidebar_position: 25
sidebar_position: 29
description: Update Commands in the local metadata using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_command_update"
keywords:
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/commands/ddn_connector-link.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: ddn connector-link
sidebar_position: 42
sidebar_position: 46
description: Perform DataConnectorLink related operations using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_connector-link"
keywords:
Expand Down
Loading
Loading