You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: MANUAL.md
+106-10
Original file line number
Diff line number
Diff line change
@@ -70,7 +70,7 @@ Log out of your current session.
70
70
71
71
Start backfilling all the resources available to the service integration.
72
72
73
-
**--integration, -i**="": Integration opaque id, starting with 'svi_'. Run `webhookdb integrations list` to see a list of all your integrations.
73
+
**--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.
74
74
75
75
**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.
76
76
@@ -136,14 +136,36 @@ Write out commands that can be used to generate a FDW against your WebhookDB dat
136
136
137
137
### rename-table
138
138
139
-
Rename the database table associated with the integration
139
+
Rename the database table associated with the integration.
140
140
141
-
**--integration, -i**="": Integration opaque id, starting with 'svi_'. Run `webhookdb integrations list` to see a list of all your integrations.
141
+
**--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.
142
142
143
143
**--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.
144
144
145
145
**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.
146
146
147
+
### migrations
148
+
149
+
Command namespace for interacting with your organizations database migrations.
150
+
151
+
#### start
152
+
153
+
Enqueue a migration of all your organization's data to a new database.
154
+
155
+
**--admin-url, -a**="":
156
+
157
+
**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.
158
+
159
+
**--readonly-url, -r**="":
160
+
161
+
#### list
162
+
163
+
List all database migrations.
164
+
165
+
**--format, -f**="": Format of the output. One of: json, csv, table, raw (default: table)
166
+
167
+
**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.
168
+
147
169
## docs
148
170
149
171
Work with the WebhookDB docs and guide.
@@ -192,7 +214,7 @@ Delete an integration and its table.
192
214
193
215
**--confirm, -c**="": Confirm this action by providing a value of the integration's table name. Will be prompted if not provided.
194
216
195
-
**--integration, -i**="": Integration opaque id, starting with 'svi_'. Run `webhookdb integrations list` to see a list of all your integrations.
217
+
**--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.
196
218
197
219
**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.
198
220
@@ -208,7 +230,7 @@ List all integrations for the given organization.
208
230
209
231
Reset the webhook secret for this integration.
210
232
211
-
**--integration, -i**="": Integration opaque id, starting with 'svi_'. Run `webhookdb integrations list` to see a list of all your integrations.
233
+
**--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.
212
234
213
235
**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.
214
236
@@ -218,7 +240,7 @@ Get statistics about webhooks for this integration.
218
240
219
241
**--format, -f**="": Format of the output. One of: json, csv, table, raw (default: table)
220
242
221
-
**--integration, -i**="": Integration opaque id, starting with 'svi_'. Run `webhookdb integrations list` to see a list of all your integrations.
243
+
**--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.
222
244
223
245
**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.
224
246
@@ -258,6 +280,8 @@ Invite a user to your organization.
258
280
259
281
**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.
260
282
283
+
**--role, -r**="": Role to assign the new organization member
284
+
261
285
**--username, -u, --email**="": Takes an email.
262
286
263
287
### join
@@ -290,14 +314,16 @@ Remove a member from an organization.
290
314
291
315
**--username, -u, --email**="": Takes an email.
292
316
293
-
### rename
317
+
### update
294
318
295
-
Change the name of the organization. Does not change the org key, which is immutable.
319
+
Change the name or billing email of the organization. (Note: the org keyis immutable and will not change.)
296
320
297
-
**--name, -n**="": New name of the organization
321
+
**--field, -f**="": The field that you want to change.
298
322
299
323
**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.
300
324
325
+
**--value, -v**="": The new value for the chosen field
326
+
301
327
## services
302
328
303
329
Work with available services that can be hooked up to reflect data to WebhookDB.
@@ -338,6 +364,76 @@ Print information about the WebhookDB pricing plans.
338
364
339
365
**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.
340
366
367
+
## sync
368
+
369
+
Replicate data in a WebhookDB table into another database.
370
+
371
+
### create
372
+
373
+
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.
374
+
375
+
**--connection-url, -u**="": The connection string for the database that WebhookDB should write data to.
376
+
377
+
**--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.
378
+
379
+
**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.
380
+
381
+
**--period**="": Number of seconds between syncs. (default: 0)
382
+
383
+
**--schema**="": Schema (or namespace) to write the table into. Default to no schema/namespace.
384
+
385
+
**--table**="": Table to create and update. Default to match the table name of the service integration.
386
+
387
+
### delete
388
+
389
+
Delete the sync target and stop any further syncing. The table being synced to is not modified.
390
+
391
+
**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.
392
+
393
+
**--target, -t**="": Sync target opaque id. Run `webhookdb sync list` to see a list of all your sync targets.
394
+
395
+
### list
396
+
397
+
List all sync targets for the given organization.
398
+
399
+
**--format, -f**="": Format of the output. One of: json, csv, table, raw (default: table)
400
+
401
+
**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.
402
+
403
+
### update
404
+
405
+
Update the sync target. Use `webhookdb sync list` to see all sync targets.
406
+
407
+
**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.
408
+
409
+
**--period**="": Number of seconds between syncs. (default: 0)
410
+
411
+
**--schema**="": Schema (or namespace) to write the table into. Default to no schema/namespace.
412
+
413
+
**--table**="": Table to create and update. Default to match the table name of the service integration.
414
+
415
+
**--target, -t**="": Sync target opaque id. Run `webhookdb sync list` to see a list of all your sync targets.
416
+
417
+
### update-creds
418
+
419
+
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.
420
+
421
+
**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.
422
+
423
+
**--password, -p**="": Takes a password.
424
+
425
+
**--target, -t**="": Sync target opaque id. Run `webhookdb sync list` to see a list of all your sync targets.
426
+
427
+
**--user, -u**="": Database username
428
+
429
+
### trigger
430
+
431
+
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.
432
+
433
+
**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.
434
+
435
+
**--target, -t**="": Sync target opaque id. Run `webhookdb sync list` to see a list of all your sync targets.
436
+
341
437
## update
342
438
343
439
Update the version of the CLI in-place.
@@ -354,7 +450,7 @@ Manage webhooks that will be notified when WebhookDB data is updated.
354
450
355
451
Create a new webhook that WebhookDB will call on every data update.
356
452
357
-
**--integration, -i**="": Integration opaque id, starting with 'svi_'. Run `webhookdb integrations list` to see a list of all your integrations.
453
+
**--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.
358
454
359
455
**--org, -o**="": Takes an org key. Run `webhook org list` to see a list of all your org keys.
0 commit comments