Skip to content

[WIP] Release bulk operations CLI commands #6699

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

Draft
jordanverasamy wants to merge 1 commit into
base: main
Choose a base branch
from
+102 −12
Draft

[WIP] Release bulk operations CLI commands #6699

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
9 changes: 6 additions & 3 deletions packages/app/src/cli/commands/app/bulk/execute.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,13 @@ import {globalFlags} from '@shopify/cli-kit/node/cli'
export default class BulkExecute extends AppLinkedCommand {
static summary = 'Execute bulk operations.'

static description =
'Executes an Admin API GraphQL query or mutation on the specified dev store, as a bulk operation.'
static descriptionWithMarkdown = `Executes an Admin API GraphQL query or mutation on the specified dev store, as a bulk operation.

static hidden = true
Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](https://shopify.dev/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](https://shopify.dev/docs/api/usage/bulk-operations/imports).

Use [\`bulk status\`](https://shopify.dev/docs/api/shopify-cli/app/app-bulk-status) to check the status of your bulk operations.`

static description = this.descriptionWithoutMarkdown()

static flags = {
...globalFlags,
Expand Down
9 changes: 6 additions & 3 deletions packages/app/src/cli/commands/app/bulk/status.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,13 @@ import {normalizeStoreFqdn} from '@shopify/cli-kit/node/context/fqdn'
export default class BulkStatus extends AppLinkedCommand {
static summary = 'Check the status of bulk operations.'

static description =
'Check the status of a specific bulk operation by ID, or list all bulk operations in the last 7 days.'
static descriptionWithMarkdown = `Check the status of a specific bulk operation by ID, or list all bulk operations in the last 7 days.

static hidden = true
Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](https://shopify.dev/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](https://shopify.dev/docs/api/usage/bulk-operations/imports).

Use [\`bulk execute\`](https://shopify.dev/docs/api/shopify-cli/app/app-bulk-execute) to start a new bulk operation.`

static description = this.descriptionWithoutMarkdown()

static flags = {
...globalFlags,
Expand Down
6 changes: 5 additions & 1 deletion packages/app/src/cli/commands/app/execute.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@ import {globalFlags} from '@shopify/cli-kit/node/cli'
export default class Execute extends AppLinkedCommand {
static summary = 'Execute GraphQL queries and mutations.'

static description = 'Executes an Admin API GraphQL query or mutation on the specified dev store.'
static descriptionWithMarkdown = `Executes an Admin API GraphQL query or mutation on the specified dev store.

For operations that process large amounts of data, use [\`bulk execute\`](https://shopify.dev/docs/api/shopify-cli/app/app-bulk-execute) instead.`

static description = this.descriptionWithoutMarkdown()

static flags = {
...globalFlags,
Expand Down
79 changes: 79 additions & 0 deletions packages/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Commands
<!-- commands -->
* [`shopify app build`](#shopify-app-build)
* [`shopify app bulk execute`](#shopify-app-bulk-execute)
* [`shopify app bulk status`](#shopify-app-bulk-status)
* [`shopify app config link`](#shopify-app-config-link)
* [`shopify app config pull`](#shopify-app-config-pull)
* [`shopify app config use [config] [flags]`](#shopify-app-config-use-config-flags)
Expand Down Expand Up @@ -118,6 +120,80 @@ DESCRIPTION
extension to ensure that it's valid.
```

## `shopify app bulk execute`

Execute bulk operations.

```
USAGE
$ shopify app bulk execute [--client-id <value> | -c <value>] [--no-color] [--output-file <value> --watch] [--path
<value>] [-q <value>] [--reset | ] [-s <value>] [--variable-file <value> | -v <value>...] [--verbose] [--version
<value>]

FLAGS
-c, --config=<value> The name of the app configuration.
-q, --query=<value> The GraphQL query or mutation to run as a bulk operation. If omitted, reads from standard
input.
-s, --store=<value> The store domain. Must be an existing dev store.
-v, --variables=<value>... The values for any GraphQL variables in your mutation, in JSON format. Can be specified
multiple times.
--client-id=<value> The Client ID of your app.
--no-color Disable color output.
--output-file=<value> The file path where results should be written if --watch is specified. If not specified,
results will be written to STDOUT.
--path=<value> The path to your app directory.
--reset Reset all your settings.
--variable-file=<value> Path to a file containing GraphQL variables in JSONL format (one JSON object per line).
Can't be used with --variables.
--verbose Increase the verbosity of the output.
--version=<value> The API version to use for the bulk operation. If not specified, uses the latest stable
version.
--watch Wait for bulk operation results before exiting. Defaults to false.

DESCRIPTION
Execute bulk operations.

Executes an Admin API GraphQL query or mutation on the specified dev store, as a bulk operation.

Bulk operations allow you to process large amounts of data asynchronously. Learn more about "bulk query operations"
(https://shopify.dev/docs/api/usage/bulk-operations/queries) and "bulk mutation operations"
(https://shopify.dev/docs/api/usage/bulk-operations/imports).

Use "`bulk status`" (https://shopify.dev/docs/api/shopify-cli/app/app-bulk-status) to check the status of your bulk
operations.
```

## `shopify app bulk status`

Check the status of bulk operations.

```
USAGE
$ shopify app bulk status [--client-id <value> | -c <value>] [--id <value>] [--no-color] [--path <value>] [--reset
| ] [-s <value>] [--verbose]

FLAGS
-c, --config=<value> The name of the app configuration.
-s, --store=<value> The store domain. Must be an existing dev store.
--client-id=<value> The Client ID of your app.
--id=<value> The bulk operation ID. If not provided, lists all bulk operations in the last 7 days.
--no-color Disable color output.
--path=<value> The path to your app directory.
--reset Reset all your settings.
--verbose Increase the verbosity of the output.

DESCRIPTION
Check the status of bulk operations.

Check the status of a specific bulk operation by ID, or list all bulk operations in the last 7 days.

Bulk operations allow you to process large amounts of data asynchronously. Learn more about "bulk query operations"
(https://shopify.dev/docs/api/usage/bulk-operations/queries) and "bulk mutation operations"
(https://shopify.dev/docs/api/usage/bulk-operations/imports).

Use "`bulk execute`" (https://shopify.dev/docs/api/shopify-cli/app/app-bulk-execute) to start a new bulk operation.
```

## `shopify app config link`

Fetch your app configuration from the Developer Dashboard.
Expand Down Expand Up @@ -379,6 +455,9 @@ DESCRIPTION
Execute GraphQL queries and mutations.

Executes an Admin API GraphQL query or mutation on the specified dev store.

For operations that process large amounts of data, use "`bulk execute`"
(https://shopify.dev/docs/api/shopify-cli/app/app-bulk-execute) instead.
```

## `shopify app function build`
Expand Down
11 changes: 6 additions & 5 deletions packages/cli/oclif.manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,8 @@
"args": {
},
"customPluginName": "@shopify/app",
"description": "Executes an Admin API GraphQL query or mutation on the specified dev store, as a bulk operation.",
"description": "Executes an Admin API GraphQL query or mutation on the specified dev store, as a bulk operation.\n\n Bulk operations allow you to process large amounts of data asynchronously. Learn more about \"bulk query operations\" (https://shopify.dev/docs/api/usage/bulk-operations/queries) and \"bulk mutation operations\" (https://shopify.dev/docs/api/usage/bulk-operations/imports).\n\n Use \"`bulk status`\" (https://shopify.dev/docs/api/shopify-cli/app/app-bulk-status) to check the status of your bulk operations.",
"descriptionWithMarkdown": "Executes an Admin API GraphQL query or mutation on the specified dev store, as a bulk operation.\n\n Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](https://shopify.dev/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](https://shopify.dev/docs/api/usage/bulk-operations/imports).\n\n Use [`bulk status`](https://shopify.dev/docs/api/shopify-cli/app/app-bulk-status) to check the status of your bulk operations.",
"flags": {
"client-id": {
"description": "The Client ID of your app.",
Expand Down Expand Up @@ -222,7 +223,6 @@
}
},
"hasDynamicHelp": false,
"hidden": true,
"hiddenAliases": [
],
"id": "app:bulk:execute",
Expand All @@ -238,7 +238,8 @@
"args": {
},
"customPluginName": "@shopify/app",
"description": "Check the status of a specific bulk operation by ID, or list all bulk operations in the last 7 days.",
"description": "Check the status of a specific bulk operation by ID, or list all bulk operations in the last 7 days.\n\n Bulk operations allow you to process large amounts of data asynchronously. Learn more about \"bulk query operations\" (https://shopify.dev/docs/api/usage/bulk-operations/queries) and \"bulk mutation operations\" (https://shopify.dev/docs/api/usage/bulk-operations/imports).\n\n Use \"`bulk execute`\" (https://shopify.dev/docs/api/shopify-cli/app/app-bulk-execute) to start a new bulk operation.",
"descriptionWithMarkdown": "Check the status of a specific bulk operation by ID, or list all bulk operations in the last 7 days.\n\n Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](https://shopify.dev/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](https://shopify.dev/docs/api/usage/bulk-operations/imports).\n\n Use [`bulk execute`](https://shopify.dev/docs/api/shopify-cli/app/app-bulk-execute) to start a new bulk operation.",
"flags": {
"client-id": {
"description": "The Client ID of your app.",
Expand Down Expand Up @@ -317,7 +318,6 @@
}
},
"hasDynamicHelp": false,
"hidden": true,
"hiddenAliases": [
],
"id": "app:bulk:status",
Expand Down Expand Up @@ -1133,7 +1133,8 @@
"args": {
},
"customPluginName": "@shopify/app",
"description": "Executes an Admin API GraphQL query or mutation on the specified dev store.",
"description": "Executes an Admin API GraphQL query or mutation on the specified dev store.\n\n For operations that process large amounts of data, use \"`bulk execute`\" (https://shopify.dev/docs/api/shopify-cli/app/app-bulk-execute) instead.",
"descriptionWithMarkdown": "Executes an Admin API GraphQL query or mutation on the specified dev store.\n\n For operations that process large amounts of data, use [`bulk execute`](https://shopify.dev/docs/api/shopify-cli/app/app-bulk-execute) instead.",
"flags": {
"client-id": {
"description": "The Client ID of your app.",
Expand Down
Loading