-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
40 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -253,43 +253,68 @@ It requires having Conduit previously running. | |
```bash | ||
$ conduit connectors ls | ||
ID PLUGIN TYPE PIPELINE | ||
my-source [email protected] builtin file-to-postgres | ||
my-source [email protected] builtin file-to-postgres | ||
my-destination [email protected]. standalone my-other-pipeline | ||
``` | ||
|
||
### `conduit connectors describe [--plugin] [--id]` | ||
### `conduit connectors describe ID` | ||
|
||
This command will describe the connector configuration available. | ||
This command will describe the existing running connector. | ||
|
||
When using `--plugin` will describe the configuration for that connector plugin. | ||
|
||
When using `--id` will require having Conduit previously running since it'll describe the existing running connector. | ||
It requires having Conduit previously running. | ||
|
||
#### Flags | ||
|
||
| Name | Description | Required | Default Value | | ||
|------|-------------|----------|---------------| | ||
| id | connector identifier (returned by `connectors ls`) | Yes | | | ||
| plugin | plugin name and version | Yes | | | ||
| grpc.address | address for serving the gRPC API | No | ":8084" | | ||
|
||
#### `--help` | ||
|
||
```bash | ||
$ conduit connnectors describe [--plugin] [--id] [--grpc.address] | ||
$ conduit connnectors describe ID [--grpc.address] | ||
|
||
EXAMPLE: | ||
|
||
$ conduit connectors describe my-source | ||
NAME URL PIPELINE PLUGIN | ||
my-source https://... my-pipeline [email protected] | ||
``` | ||
|
||
### `conduit connector-plugins ls` | ||
|
||
This command will list all the available connector plugins. | ||
|
||
It does not require having Conduit previously running. | ||
|
||
#### `--help` | ||
|
||
```bash | ||
$ conduit connector-plugins ls | ||
PLUGIN | ||
[email protected] | ||
[email protected] | ||
``` | ||
|
||
### `conduit connector-plugins PLUGIN` | ||
|
||
This command will describe the configuration for that connector plugin. | ||
|
||
It does not require having Conduit previously running. | ||
|
||
#### `--help` | ||
|
||
```bash | ||
$ conduit connnector-plugins describe PLUGIN | ||
|
||
EXAMPLE: | ||
|
||
$ conduit connectors describe --plugin [email protected] | ||
$ conduit connector-plugins describe [email protected] | ||
NAME DESCRIPTION REQUIRED DEFAULT VALUE EXAMPLE | ||
url HTTP URL to send requests to. true https://... | ||
... | ||
|
||
$ conduit connectors describe --id my-source | ||
NAME URL PIPELINE | ||
my-source https://... my-pipeline | ||
``` | ||
|
||
|
||
Check failure on line 317 in docs/design-documents/20241024-conduit-cli.md GitHub Actions / markdownlint-cli2Multiple consecutive blank lines
|
||
### `conduit processors ls` | ||
|
||
This command will list all the available processors. | ||
|