Skip to content

Commit

Permalink
Regenerate MANUAL
Browse files Browse the repository at this point in the history
  • Loading branch information
rgalanakis committed Aug 29, 2022
1 parent dc070f4 commit b289d94
Showing 1 changed file with 106 additions and 10 deletions.
116 changes: 106 additions & 10 deletions MANUAL.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Log out of your current session.

Start backfilling all the resources available to the service integration.

**--integration, -i**="": Integration opaque id, starting with 'svi_'. Run `webhookdb integrations list` to see a list of all your integrations.
**--integration, -i**="": Integration identifier. This can either be the service name, the table name, or the opaque id, which is a unique code that starts with 'svi_'. Run webhookdb integrations list to see a list of all your integrations.

**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.

Expand Down Expand Up @@ -136,14 +136,36 @@ Write out commands that can be used to generate a FDW against your WebhookDB dat

### rename-table

Rename the database table associated with the integration
Rename the database table associated with the integration.

**--integration, -i**="": Integration opaque id, starting with 'svi_'. Run `webhookdb integrations list` to see a list of all your integrations.
**--integration, -i**="": Integration identifier. This can either be the service name, the table name, or the opaque id, which is a unique code that starts with 'svi_'. Run webhookdb integrations list to see a list of all your integrations.

**--new-name, -n**="": The new name of the table. Valid table names must adhere to the following rules: must begin with an ASCII letter, contain only ASCII letters, numbers, underscores, dashes, and spaces, can begin and end with double quotes, and must otherwise be a valid Postgres identifier.

**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.

### migrations

Command namespace for interacting with your organizations database migrations.

#### start

Enqueue a migration of all your organization's data to a new database.

**--admin-url, -a**="":

**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.

**--readonly-url, -r**="":

#### list

List all database migrations.

**--format, -f**="": Format of the output. One of: json, csv, table, raw (default: table)

**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.

## docs

Work with the WebhookDB docs and guide.
Expand Down Expand Up @@ -192,7 +214,7 @@ Delete an integration and its table.

**--confirm, -c**="": Confirm this action by providing a value of the integration's table name. Will be prompted if not provided.

**--integration, -i**="": Integration opaque id, starting with 'svi_'. Run `webhookdb integrations list` to see a list of all your integrations.
**--integration, -i**="": Integration identifier. This can either be the service name, the table name, or the opaque id, which is a unique code that starts with 'svi_'. Run webhookdb integrations list to see a list of all your integrations.

**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.

Expand All @@ -208,7 +230,7 @@ List all integrations for the given organization.

Reset the webhook secret for this integration.

**--integration, -i**="": Integration opaque id, starting with 'svi_'. Run `webhookdb integrations list` to see a list of all your integrations.
**--integration, -i**="": Integration identifier. This can either be the service name, the table name, or the opaque id, which is a unique code that starts with 'svi_'. Run webhookdb integrations list to see a list of all your integrations.

**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.

Expand All @@ -218,7 +240,7 @@ Get statistics about webhooks for this integration.

**--format, -f**="": Format of the output. One of: json, csv, table, raw (default: table)

**--integration, -i**="": Integration opaque id, starting with 'svi_'. Run `webhookdb integrations list` to see a list of all your integrations.
**--integration, -i**="": Integration identifier. This can either be the service name, the table name, or the opaque id, which is a unique code that starts with 'svi_'. Run webhookdb integrations list to see a list of all your integrations.

**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.

Expand Down Expand Up @@ -258,6 +280,8 @@ Invite a user to your organization.

**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.

**--role, -r**="": Role to assign the new organization member

**--username, -u, --email**="": Takes an email.

### join
Expand Down Expand Up @@ -290,14 +314,16 @@ Remove a member from an organization.

**--username, -u, --email**="": Takes an email.

### rename
### update

Change the name of the organization. Does not change the org key, which is immutable.
Change the name or billing email of the organization. (Note: the org key is immutable and will not change.)

**--name, -n**="": New name of the organization
**--field, -f**="": The field that you want to change.

**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.

**--value, -v**="": The new value for the chosen field

## services

Work with available services that can be hooked up to reflect data to WebhookDB.
Expand Down Expand Up @@ -338,6 +364,76 @@ Print information about the WebhookDB pricing plans.

**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.

## sync

Replicate data in a WebhookDB table into another database.

### create

Create a sync target for the specified integration. Data will be automatically synced from the integration's WebhookDB table into the database specified by the connection string. PostgresQL and SnowflakeDB databases are supported.

**--connection-url, -u**="": The connection string for the database that WebhookDB should write data to.

**--integration, -i**="": Integration identifier. This can either be the service name, the table name, or the opaque id, which is a unique code that starts with 'svi_'. Run webhookdb integrations list to see a list of all your integrations.

**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.

**--period**="": Number of seconds between syncs. (default: 0)

**--schema**="": Schema (or namespace) to write the table into. Default to no schema/namespace.

**--table**="": Table to create and update. Default to match the table name of the service integration.

### delete

Delete the sync target and stop any further syncing. The table being synced to is not modified.

**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.

**--target, -t**="": Sync target opaque id. Run `webhookdb sync list` to see a list of all your sync targets.

### list

List all sync targets for the given organization.

**--format, -f**="": Format of the output. One of: json, csv, table, raw (default: table)

**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.

### update

Update the sync target. Use `webhookdb sync list` to see all sync targets.

**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.

**--period**="": Number of seconds between syncs. (default: 0)

**--schema**="": Schema (or namespace) to write the table into. Default to no schema/namespace.

**--table**="": Table to create and update. Default to match the table name of the service integration.

**--target, -t**="": Sync target opaque id. Run `webhookdb sync list` to see a list of all your sync targets.

### update-creds

Update credentials for the sync target. If the database URL used to sync is changing, you must use update-creds so WebhookDB can continue to write to it.

**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.

**--password, -p**="": Takes a password.

**--target, -t**="": Sync target opaque id. Run `webhookdb sync list` to see a list of all your sync targets.

**--user, -u**="": Database username

### trigger

Trigger a sync to the sync target. The sync will happen at the earliest possible moment since the last sync, no matter how long the configured period is on the sync target.

**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.

**--target, -t**="": Sync target opaque id. Run `webhookdb sync list` to see a list of all your sync targets.

## update

Update the version of the CLI in-place.
Expand All @@ -354,7 +450,7 @@ Manage webhooks that will be notified when WebhookDB data is updated.

Create a new webhook that WebhookDB will call on every data update.

**--integration, -i**="": Integration opaque id, starting with 'svi_'. Run `webhookdb integrations list` to see a list of all your integrations.
**--integration, -i**="": Integration identifier. This can either be the service name, the table name, or the opaque id, which is a unique code that starts with 'svi_'. Run webhookdb integrations list to see a list of all your integrations.

**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.

Expand Down

0 comments on commit b289d94

Please sign in to comment.