connectors
Generated by connectors-docs from the definition the connectors binary parses: the command tree that ESS generates from the CLI binding apps/connectors/spec/cli.yaml, as apps/connectors/src/help.rs presents it. It lists only commands that exist. connectors --version prints the version, and --help after any command prints its usage.
Local integration access through explicitly configured connector instances. After an upgrade,
connectors setup owner-stopstops the owner an older binary started
Global options
Every command accepts these, anywhere on the command line.
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--config <global_config> | no | none | any | |
--state-dir <global_state> | no | none | any | |
--output <global_output> | no | human | human, json |
More columns: swipe horizontally, or focus the table and use the arrow keys.
Commands
| Command | What it does |
|---|---|
connectors adapters describe | Deprecated name of connectors instances describe |
connectors adapters list | Deprecated name of connectors instances list |
connectors adapters status | Deprecated name of connectors instances status |
connectors adapters stop | Deprecated name of connectors instances stop |
connectors approvals clock-check | Check the configured authenticated clock without starting services |
connectors approvals issue | Approve the exact reconstructed subject and publish a new protected proof file |
connectors approvals key-init | Create a new approval-signing key in protected local custody |
connectors approvals key-recover | Confirm and publish an exact staged approval-signing key |
connectors approvals key-retire | Delete exact noncurrent signing material while retaining public history |
connectors approvals key-revoke | Revoke the current key and cancel its pending replacement |
connectors approvals key-rotate | Publish a replacement for the exact current approval-signing key |
connectors approvals key-status | Observe public key metadata without starting services or reading secrets |
connectors approvals policy-set | Publish the exact permitted write-operation set under revision control |
connectors approvals policy-status | Inspect retained local write policy without starting services |
connectors approvals prepare | Resolve the exact approval subject without provider or credential access |
connectors connections connect | Begin admitted local protected credential acquisition on |
connectors connections describe | Inspect safe metadata for one connection |
connectors connections launch | Run a pinned consumer with one connection's credential on descriptor 3 |
connectors connections list | List safe connection metadata |
connectors connections reconnect | Publish a new credential on the exact connection without changing its identity; connections repair is its deprecated name |
connectors connections repair | Deprecated name of connectors connections reconnect |
connectors connections revalidate | Revalidate the saved credential without re-entry |
connectors connections revoke | Commit terminal local revocation under the current fence |
connectors connections status | Observe exactly one connection or acquisition |
connectors connections token | Issue a current access token of one OAuth2 connection, printed only with --reveal |
connectors definitions install | Fetch the connectors-definitions release TAG from SOURCE (an https repository URL or a local directory), check every file against its index.json, and record it in definitions.lock and a read-only cache; grants nothing and starts no process |
connectors instances describe | Inspect one configured instance and its cached descriptor; adapters describe is its deprecated name |
connectors instances list | List configured instances; adapters list is its deprecated name |
connectors instances status | Observe the lifecycle owner of the process that serves one instance; adapters status is its deprecated name |
connectors instances stop | Stop only the exact owned incarnation of the process that serves one instance; adapters stop is its deprecated name |
connectors invoke | Invoke one operation of a connector's instance; the instance, connection, schema and revision default to the only ones that fit |
connectors list | List every connector this build ships, with its auth profiles and the instances the configuration names; needs no configuration and starts no process |
connectors operations describe | Inspect an operation and its exact schema identity |
connectors operations list | List operations from selected cached metadata |
connectors setup check | Check local configuration and prerequisites without authentication |
connectors setup checkpoints-enable | Enable durable open checkpoints on the existing store; one-way, connectors 0.32.0 and earlier can no longer open it |
connectors setup init | Create private local configuration without starting services |
connectors setup migrate | Rewrite each entry of the legacy configuration format that maps to a shipped connector as that connector's instance, keeping its instance id and revision, in the short form when the installed provider derives it unchanged; --mode dry-run (or --dry-run) prints the new file, --mode apply (or --apply) writes it and keeps the old one as config.toml.before-migrate-TIMESTAMP (UTC) |
connectors setup owner-stop | Stop this state directory's running owner, of any build, within 30 seconds; run it after an upgrade when a command answers next_action stop_owner |
connectors completions | Emit shell completions |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors adapters describe
Deprecated name of connectors instances describe
connectors adapters describe [OPTIONS] (deprecated; use connectors instances describe)
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors adapters list
Deprecated name of connectors instances list
connectors adapters list [OPTIONS] (deprecated; use connectors instances list)
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--limit <field:limit> | no | none | any | |
--cursor <field:cursor> | no | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors adapters status
Deprecated name of connectors instances status
connectors adapters status [OPTIONS] (deprecated; use connectors instances status)
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors adapters stop
Deprecated name of connectors instances stop
connectors adapters stop [OPTIONS] --expected-revision <field:expected_revision> --host-incarnation <field:host_incarnation> --child-incarnation <field:child_incarnation> (deprecated; use connectors instances stop)
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any | |
--expected-revision <field:expected_revision> | yes | none | any | |
--host-incarnation <field:host_incarnation> | yes | none | any | |
--child-incarnation <field:child_incarnation> | yes | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors approvals clock-check
Check the configured authenticated clock without starting services
connectors approvals clock-check [OPTIONS]
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors approvals issue
Approve the exact reconstructed subject and publish a new protected proof file
connectors approvals issue [OPTIONS] --connection <field:connection> --operation <field:operation> --schema <field:schema> --revision <field:revision> --approve-subject <field:approve_subject> --proof-output <field:proof_output> <--input-json <source:input:inline>|--input-file <source:input:file>|--input-stdin>
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any | |
--connection <field:connection> | yes | none | any | |
--operation <field:operation> | yes | none | any | |
--schema <field:schema> | yes | none | any | |
--revision <field:revision> | yes | none | any | |
--input-json <source:input:inline> | no | none | any | |
--input-file <source:input:file> | no | none | any | |
--input-stdin | no | false | any | |
--approve-subject <field:approve_subject> | yes | none | any | |
--proof-output <field:proof_output> | yes | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors approvals key-init
Create a new approval-signing key in protected local custody
connectors approvals key-init [OPTIONS]
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any | |
--expected-revision <field:expected_revision> | no | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors approvals key-recover
Confirm and publish an exact staged approval-signing key
connectors approvals key-recover [OPTIONS] --expected-revision <field:expected_revision> --candidate <field:candidate>
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any | |
--expected-revision <field:expected_revision> | yes | none | any | |
--candidate <field:candidate> | yes | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors approvals key-retire
Delete exact noncurrent signing material while retaining public history
connectors approvals key-retire [OPTIONS] --expected-revision <field:expected_revision> --key <field:key>
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any | |
--expected-revision <field:expected_revision> | yes | none | any | |
--key <field:key> | yes | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors approvals key-revoke
Revoke the current key and cancel its pending replacement
connectors approvals key-revoke [OPTIONS] --expected-revision <field:expected_revision> --expected-key <field:expected_key>
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any | |
--expected-revision <field:expected_revision> | yes | none | any | |
--expected-key <field:expected_key> | yes | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors approvals key-rotate
Publish a replacement for the exact current approval-signing key
connectors approvals key-rotate [OPTIONS] --expected-revision <field:expected_revision> --expected-key <field:expected_key>
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any | |
--expected-revision <field:expected_revision> | yes | none | any | |
--expected-key <field:expected_key> | yes | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors approvals key-status
Observe public key metadata without starting services or reading secrets
connectors approvals key-status [OPTIONS]
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors approvals policy-set
Publish the exact permitted write-operation set under revision control
connectors approvals policy-set [OPTIONS] --input-file <field:input_file>
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any | |
--expected-revision <field:expected_revision> | no | none | any | |
--input-file <field:input_file> | yes | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors approvals policy-status
Inspect retained local write policy without starting services
connectors approvals policy-status [OPTIONS]
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors approvals prepare
Resolve the exact approval subject without provider or credential access
connectors approvals prepare [OPTIONS] --connection <field:connection> --operation <field:operation> --schema <field:schema> --revision <field:revision> <--input-json <source:input:inline>|--input-file <source:input:file>|--input-stdin>
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any | |
--connection <field:connection> | yes | none | any | |
--operation <field:operation> | yes | none | any | |
--schema <field:schema> | yes | none | any | |
--revision <field:revision> | yes | none | any | |
--input-json <source:input:inline> | no | none | any | |
--input-file <source:input:file> | no | none | any | |
--input-stdin | no | false | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors connections connect
Begin admitted local protected credential acquisition on
connectors connections connect [OPTIONS] --profile <field:profile> [field:target]
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any | |
--profile <field:profile> | yes | none | any | |
--device <field:device> | no | none | any | |
--credential-file <source:credential_document:file> | no | none | any | |
--credential-stdin | no | false | any | |
--credential-prompt | no | false | any | |
<field:target> | no | none | any | |
--endpoint <field:endpoint> | no | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors connections describe
Inspect safe metadata for one connection
connectors connections describe [OPTIONS]
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any | |
--connection <field:connection> | no | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors connections launch
Run a pinned consumer with one connection's credential on descriptor 3
connectors connections launch [OPTIONS] --consumer <field:consumer>
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any | |
--connection <field:connection> | no | none | any | |
--consumer <field:consumer> | yes | none | any | |
--args <field:args> | no | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors connections list
List safe connection metadata
connectors connections list [OPTIONS]
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any | |
--limit <field:limit> | no | none | any | |
--cursor <field:cursor> | no | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors connections reconnect
Publish a new credential on the exact connection without changing its identity; connections repair is its deprecated name
connectors connections reconnect [OPTIONS] --expected-revision <field:expected_revision>
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any | |
--connection <field:connection> | no | none | any | |
--expected-revision <field:expected_revision> | yes | none | any | |
--device <field:device> | no | none | any | |
--credential-file <source:credential_document:file> | no | none | any | |
--credential-stdin | no | false | any | |
--credential-prompt | no | false | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors connections repair
Deprecated name of connectors connections reconnect
connectors connections repair [OPTIONS] --expected-revision <field:expected_revision> (deprecated; use connectors connections reconnect)
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any | |
--connection <field:connection> | no | none | any | |
--expected-revision <field:expected_revision> | yes | none | any | |
--device <field:device> | no | none | any | |
--credential-file <source:credential_document:file> | no | none | any | |
--credential-stdin | no | false | any | |
--credential-prompt | no | false | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors connections revalidate
Revalidate the saved credential without re-entry
connectors connections revalidate [OPTIONS] --expected-revision <field:expected_revision>
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any | |
--connection <field:connection> | no | none | any | |
--expected-revision <field:expected_revision> | yes | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors connections revoke
Commit terminal local revocation under the current fence
connectors connections revoke [OPTIONS] --expected-revision <field:expected_revision>
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any | |
--connection <field:connection> | no | none | any | |
--expected-revision <field:expected_revision> | yes | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors connections status
Observe exactly one connection or acquisition
connectors connections status [OPTIONS]
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any | |
--connection <field:connection> | no | none | any | |
--acquisition <field:acquisition> | no | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors connections token
Issue a current access token of one OAuth2 connection, printed only with --reveal
connectors connections token [OPTIONS]
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any | |
--connection <field:connection> | no | none | any | |
--reveal <field:reveal> | no | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors definitions install
Fetch the connectors-definitions release TAG from SOURCE (an https repository URL or a local directory), check every file against its index.json, and record it in definitions.lock and a read-only cache; grants nothing and starts no process
connectors definitions install [OPTIONS] --source <field:source> --tag <field:tag>
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--source <field:source> | yes | none | any | |
--tag <field:tag> | yes | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors instances describe
Inspect one configured instance and its cached descriptor; adapters describe is its deprecated name
connectors instances describe [OPTIONS]
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors instances list
List configured instances; adapters list is its deprecated name
connectors instances list [OPTIONS]
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--limit <field:limit> | no | none | any | |
--cursor <field:cursor> | no | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors instances status
Observe the lifecycle owner of the process that serves one instance; adapters status is its deprecated name
connectors instances status [OPTIONS]
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors instances stop
Stop only the exact owned incarnation of the process that serves one instance; adapters stop is its deprecated name
connectors instances stop [OPTIONS] --expected-revision <field:expected_revision> --host-incarnation <field:host_incarnation> --child-incarnation <field:child_incarnation>
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any | |
--expected-revision <field:expected_revision> | yes | none | any | |
--host-incarnation <field:host_incarnation> | yes | none | any | |
--child-incarnation <field:child_incarnation> | yes | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors invoke
Invoke one operation of a connector's instance; the instance, connection, schema and revision default to the only ones that fit
connectors invoke [OPTIONS] [CONNECTOR[/INSTANCE]] <OPERATION>
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
<CONNECTOR[/INSTANCE]> | no | none | any | The connector, and after one / its instance; the instance may be left out when the connector has only one; with --definition the target may be left out, the file naming the connector |
<OPERATION> | yes | none | any | The operation to invoke |
--connection <field:connection> | no | none | any | The connection to invoke through; the instance's only usable one when left out |
--schema <field:schema> | no | none | any | A pin: the operation's schema identity, refused when the current description differs; taken from it when left out |
--revision <field:revision> | no | none | any | A pin: the description's revision, refused when the current description differs; taken from it when left out |
--input-json <source:input:inline> | no | none | any | The input document, as JSON text |
--input-file <source:input:file> | no | none | any | A file holding the input document |
--input-stdin | no | false | any | Read the input document from standard input, as happens when no input flag is given |
--approval-file <field:approval_file> | no | none | any | The approval proof a write is invoked with |
--idempotency-key <field:idempotency_key> | no | none | any | A write's idempotency key |
--definition <field:definition> | no | none | any | A connectors-definition/1 file to invoke without configuring it; a target, when given, names its connector |
--definitions-root <field:definitions_root> | no | none | any | With --definition: the tree holding its vendored source and shared auth files [default: the parent of the file's directory] |
--credential-file <field:credential_file> | no | none | any | With --definition: the OAuth client file to connect with when the instance has no connection |
--describe <field:describe> | no | none | any | true: print the operation's description, effect, schema and revision, and invoke nothing |
--fields <field:fields> | no | none | any | Print only these members of the provider result: comma-separated paths such as ticket.id, events[].field_name, alias:path or the pointer /page[after]; unmatched paths are listed in missing |
--each <field:each> | no | none | any | Print one JSON line per element of the array at this path, each shaped by --fields, then the envelope; refused on a write |
--walk <field:walk> | no | none | any | true: read every page of the walk the read declares, one invoke per page, writing each record as one JSON line to --out, then print a summary |
--max-pages <field:max_pages> | no | none | any | With --walk: the most pages read, 1 to 10000 [default: 20]; a walk stopped there names its next input in resume |
--out <field:out> | no | none | any | With --walk: a new file the records are written to, owner-only, or - for standard output |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors list
List every connector this build ships, with its auth profiles and the instances the configuration names; needs no configuration and starts no process
connectors list [OPTIONS]
connectors operations describe
Inspect an operation and its exact schema identity
connectors operations describe [OPTIONS] --operation <field:operation>
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any | |
--connection <field:connection> | no | none | any | |
--operation <field:operation> | yes | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors operations list
List operations from selected cached metadata
connectors operations list [OPTIONS]
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--adapter <ALIAS> | no | none | any | Deprecated: the alias of a configured entry; select with --connector and --instance |
--connector <field:connector> | no | none | any | |
--instance <field:instance> | no | none | any | |
--connection <field:connection> | no | none | any | |
--family <field:family> | no | none | any | |
--limit <field:limit> | no | none | any | |
--cursor <field:cursor> | no | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors setup check
Check local configuration and prerequisites without authentication
connectors setup check [OPTIONS]
connectors setup checkpoints-enable
Enable durable open checkpoints on the existing store; one-way, connectors 0.32.0 and earlier can no longer open it
connectors setup checkpoints-enable [OPTIONS]
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--confirm <field:confirm> | no | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors setup init
Create private local configuration without starting services
connectors setup init [OPTIONS]
connectors setup migrate
Rewrite each entry of the legacy configuration format that maps to a shipped connector as that connector's instance, keeping its instance id and revision, in the short form when the installed provider derives it unchanged; --mode dry-run (or --dry-run) prints the new file, --mode apply (or --apply) writes it and keeps the old one as config.toml.before-migrate-TIMESTAMP (UTC)
connectors setup migrate [OPTIONS] --mode <field:mode>
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
--mode <field:mode> | yes | none | any |
More columns: swipe horizontally, or focus the table and use the arrow keys.
connectors setup owner-stop
Stop this state directory's running owner, of any build, within 30 seconds; run it after an upgrade when a command answers next_action stop_owner
connectors setup owner-stop [OPTIONS]
connectors completions
Emit shell completions
connectors completions [OPTIONS] <shell>
| Argument | Required | Default | Values | Meaning |
|---|---|---|---|---|
<shell> | yes | none | bash |
More columns: swipe horizontally, or focus the table and use the arrow keys.