Skip to content

Commit 6eed2c6

Browse files
jordanverasamyjordanverasamy
committed
Release app execute and app bulk execute commands
1 parent 1ccfc0d commit 6eed2c6

File tree

17 files changed

+909
-16
lines changed

17 files changed

+909
-16
lines changed

‎.changeset/smart-squids-warn.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@shopify/app': minor
3+
---
4+
5+
Introduce `app execute` and `app bulk execute` commands to run queries and mutations

‎docs-shopify.dev/commands/app-bulk-execute.doc.ts‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
// This is an autogenerated file. Don't edit this file manually.
2+
import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
3+
4+
const data: ReferenceEntityTemplateSchema = {
5+
name: 'app bulk execute',
6+
description: `Executes an Admin API GraphQL query or mutation on the specified store, as a bulk operation. Mutations are only allowed on dev stores.
7+
8+
Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](/docs/api/usage/bulk-operations/imports).
9+
10+
Use [\`bulk status\`](/docs/api/shopify-cli/app/app-bulk-status) to check the status of your bulk operations.`,
11+
overviewPreviewDescription: `Execute bulk operations.`,
12+
type: 'command',
13+
isVisualComponent: false,
14+
defaultExample: {
15+
codeblock: {
16+
tabs: [
17+
{
18+
title: 'app bulk execute',
19+
code: './examples/app-bulk-execute.example.sh',
20+
language: 'bash',
21+
},
22+
],
23+
title: 'app bulk execute',
24+
},
25+
},
26+
definitions: [
27+
{
28+
title: 'Flags',
29+
description: 'The following flags are available for the `app bulk execute` command:',
30+
type: 'appbulkexecute',
31+
},
32+
],
33+
category: 'app',
34+
related: [
35+
],
36+
}
37+
38+
export default data

‎docs-shopify.dev/commands/app-bulk-status.doc.ts‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
// This is an autogenerated file. Don't edit this file manually.
2+
import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
3+
4+
const data: ReferenceEntityTemplateSchema = {
5+
name: 'app bulk status',
6+
description: `Check the status of a specific bulk operation by ID, or list all bulk operations belonging to this app on this store in the last 7 days.
7+
8+
Bulk operations allow you to process large amounts of data asynchronously. Learn more about [bulk query operations](/docs/api/usage/bulk-operations/queries) and [bulk mutation operations](/docs/api/usage/bulk-operations/imports).
9+
10+
Use [\`bulk execute\`](/docs/api/shopify-cli/app/app-bulk-execute) to start a new bulk operation.`,
11+
overviewPreviewDescription: `Check the status of bulk operations.`,
12+
type: 'command',
13+
isVisualComponent: false,
14+
defaultExample: {
15+
codeblock: {
16+
tabs: [
17+
{
18+
title: 'app bulk status',
19+
code: './examples/app-bulk-status.example.sh',
20+
language: 'bash',
21+
},
22+
],
23+
title: 'app bulk status',
24+
},
25+
},
26+
definitions: [
27+
{
28+
title: 'Flags',
29+
description: 'The following flags are available for the `app bulk status` command:',
30+
type: 'appbulkstatus',
31+
},
32+
],
33+
category: 'app',
34+
related: [
35+
],
36+
}
37+
38+
export default data

‎docs-shopify.dev/commands/app-execute.doc.ts‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
// This is an autogenerated file. Don't edit this file manually.
2+
import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'
3+
4+
const data: ReferenceEntityTemplateSchema = {
5+
name: 'app execute',
6+
description: `Executes an Admin API GraphQL query or mutation on the specified store. Mutations are only allowed on dev stores.
7+
8+
For operations that process large amounts of data, use [\`bulk execute\`](/docs/api/shopify-cli/app/app-bulk-execute) instead.`,
9+
overviewPreviewDescription: `Execute GraphQL queries and mutations.`,
10+
type: 'command',
11+
isVisualComponent: false,
12+
defaultExample: {
13+
codeblock: {
14+
tabs: [
15+
{
16+
title: 'app execute',
17+
code: './examples/app-execute.example.sh',
18+
language: 'bash',
19+
},
20+
],
21+
title: 'app execute',
22+
},
23+
},
24+
definitions: [
25+
{
26+
title: 'Flags',
27+
description: 'The following flags are available for the `app execute` command:',
28+
type: 'appexecute',
29+
},
30+
],
31+
category: 'app',
32+
related: [
33+
],
34+
}
35+
36+
export default data

‎docs-shopify.dev/commands/examples/app-bulk-execute.example.sh‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
shopify app bulk execute [flags]

‎docs-shopify.dev/commands/examples/app-bulk-status.example.sh‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
shopify app bulk status [flags]

‎docs-shopify.dev/commands/examples/app-execute.example.sh‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
shopify app execute [flags]

‎docs-shopify.dev/commands/interfaces/app-bulk-execute.interface.ts‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
// This is an autogenerated file. Don't edit this file manually.
2+
export interface appbulkexecute {
3+
/**
4+
* The Client ID of your app.
5+
* @environment SHOPIFY_FLAG_CLIENT_ID
6+
*/
7+
'--client-id <value>'?: string
8+
9+
/**
10+
* The name of the app configuration.
11+
* @environment SHOPIFY_FLAG_APP_CONFIG
12+
*/
13+
'-c, --config <value>'?: string
14+
15+
/**
16+
* Disable color output.
17+
* @environment SHOPIFY_FLAG_NO_COLOR
18+
*/
19+
'--no-color'?: ''
20+
21+
/**
22+
* The file path where results should be written if --watch is specified. If not specified, results will be written to STDOUT.
23+
* @environment SHOPIFY_FLAG_OUTPUT_FILE
24+
*/
25+
'--output-file <value>'?: string
26+
27+
/**
28+
* The path to your app directory.
29+
* @environment SHOPIFY_FLAG_PATH
30+
*/
31+
'--path <value>'?: string
32+
33+
/**
34+
* The GraphQL query or mutation to run as a bulk operation.
35+
* @environment SHOPIFY_FLAG_QUERY
36+
*/
37+
'-q, --query <value>'?: string
38+
39+
/**
40+
* Path to a file containing the GraphQL query or mutation. Can't be used with --query.
41+
* @environment SHOPIFY_FLAG_QUERY_FILE
42+
*/
43+
'--query-file <value>'?: string
44+
45+
/**
46+
* Reset all your settings.
47+
* @environment SHOPIFY_FLAG_RESET
48+
*/
49+
'--reset'?: ''
50+
51+
/**
52+
* The store domain. Must be an existing dev store.
53+
* @environment SHOPIFY_FLAG_STORE
54+
*/
55+
'-s, --store <value>'?: string
56+
57+
/**
58+
* Path to a file containing GraphQL variables in JSONL format (one JSON object per line). Can't be used with --variables.
59+
* @environment SHOPIFY_FLAG_VARIABLE_FILE
60+
*/
61+
'--variable-file <value>'?: string
62+
63+
/**
64+
* The values for any GraphQL variables in your mutation, in JSON format. Can be specified multiple times.
65+
* @environment SHOPIFY_FLAG_VARIABLES
66+
*/
67+
'-v, --variables <value>'?: string
68+
69+
/**
70+
* Increase the verbosity of the output.
71+
* @environment SHOPIFY_FLAG_VERBOSE
72+
*/
73+
'--verbose'?: ''
74+
75+
/**
76+
* The API version to use for the bulk operation. If not specified, uses the latest stable version.
77+
* @environment SHOPIFY_FLAG_VERSION
78+
*/
79+
'--version <value>'?: string
80+
81+
/**
82+
* Wait for bulk operation results before exiting. Defaults to false.
83+
* @environment SHOPIFY_FLAG_WATCH
84+
*/
85+
'--watch'?: ''
86+
}

‎docs-shopify.dev/commands/interfaces/app-bulk-status.interface.ts‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
// This is an autogenerated file. Don't edit this file manually.
2+
export interface appbulkstatus {
3+
/**
4+
* The Client ID of your app.
5+
* @environment SHOPIFY_FLAG_CLIENT_ID
6+
*/
7+
'--client-id <value>'?: string
8+
9+
/**
10+
* The name of the app configuration.
11+
* @environment SHOPIFY_FLAG_APP_CONFIG
12+
*/
13+
'-c, --config <value>'?: string
14+
15+
/**
16+
* The bulk operation ID (numeric ID or full GID). If not provided, lists all bulk operations belonging to this app on this store in the last 7 days.
17+
* @environment SHOPIFY_FLAG_ID
18+
*/
19+
'--id <value>'?: string
20+
21+
/**
22+
* Disable color output.
23+
* @environment SHOPIFY_FLAG_NO_COLOR
24+
*/
25+
'--no-color'?: ''
26+
27+
/**
28+
* The path to your app directory.
29+
* @environment SHOPIFY_FLAG_PATH
30+
*/
31+
'--path <value>'?: string
32+
33+
/**
34+
* Reset all your settings.
35+
* @environment SHOPIFY_FLAG_RESET
36+
*/
37+
'--reset'?: ''
38+
39+
/**
40+
* The store domain. Must be an existing dev store.
41+
* @environment SHOPIFY_FLAG_STORE
42+
*/
43+
'-s, --store <value>'?: string
44+
45+
/**
46+
* Increase the verbosity of the output.
47+
* @environment SHOPIFY_FLAG_VERBOSE
48+
*/
49+
'--verbose'?: ''
50+
}

‎docs-shopify.dev/commands/interfaces/app-execute.interface.ts‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
// This is an autogenerated file. Don't edit this file manually.
2+
export interface appexecute {
3+
/**
4+
* The Client ID of your app.
5+
* @environment SHOPIFY_FLAG_CLIENT_ID
6+
*/
7+
'--client-id <value>'?: string
8+
9+
/**
10+
* The name of the app configuration.
11+
* @environment SHOPIFY_FLAG_APP_CONFIG
12+
*/
13+
'-c, --config <value>'?: string
14+
15+
/**
16+
* Disable color output.
17+
* @environment SHOPIFY_FLAG_NO_COLOR
18+
*/
19+
'--no-color'?: ''
20+
21+
/**
22+
* The file name where results should be written, instead of STDOUT.
23+
* @environment SHOPIFY_FLAG_OUTPUT_FILE
24+
*/
25+
'--output-file <value>'?: string
26+
27+
/**
28+
* The path to your app directory.
29+
* @environment SHOPIFY_FLAG_PATH
30+
*/
31+
'--path <value>'?: string
32+
33+
/**
34+
* The GraphQL query or mutation, as a string.
35+
* @environment SHOPIFY_FLAG_QUERY
36+
*/
37+
'-q, --query <value>'?: string
38+
39+
/**
40+
* Path to a file containing the GraphQL query or mutation. Can't be used with --query.
41+
* @environment SHOPIFY_FLAG_QUERY_FILE
42+
*/
43+
'--query-file <value>'?: string
44+
45+
/**
46+
* Reset all your settings.
47+
* @environment SHOPIFY_FLAG_RESET
48+
*/
49+
'--reset'?: ''
50+
51+
/**
52+
* The myshopify.com domain of the store to execute against. The app must be installed on the store. If not specified, you will be prompted to select a store.
53+
* @environment SHOPIFY_FLAG_STORE
54+
*/
55+
'-s, --store <value>'?: string
56+
57+
/**
58+
* Path to a file containing GraphQL variables in JSON format. Can't be used with --variables.
59+
* @environment SHOPIFY_FLAG_VARIABLE_FILE
60+
*/
61+
'--variable-file <value>'?: string
62+
63+
/**
64+
* The values for any GraphQL variables in your query or mutation, in JSON format.
65+
* @environment SHOPIFY_FLAG_VARIABLES
66+
*/
67+
'-v, --variables <value>'?: string
68+
69+
/**
70+
* Increase the verbosity of the output.
71+
* @environment SHOPIFY_FLAG_VERBOSE
72+
*/
73+
'--verbose'?: ''
74+
75+
/**
76+
* The API version to use for the query or mutation. Defaults to the latest stable version.
77+
* @environment SHOPIFY_FLAG_VERSION
78+
*/
79+
'--version <value>'?: string
80+
}

0 commit comments

Comments
 (0)