appwrite-cli 13.0.0-rc.2 → 13.0.0-rc.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/{npm-publish.yml → publish.yml} +1 -1
- package/CHANGELOG.md +106 -101
- package/LICENSE.md +2 -2
- package/README.md +36 -59
- package/cli.ts +152 -0
- package/dist/bundle.cjs +4613 -3653
- package/dist/cli.d.ts +3 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +145 -0
- package/dist/cli.js.map +1 -0
- package/dist/index.d.ts +10 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +7 -142
- package/dist/index.js.map +1 -1
- package/dist/lib/client.d.ts.map +1 -1
- package/dist/lib/client.js +7 -6
- package/dist/lib/client.js.map +1 -1
- package/dist/lib/commands/config.d.ts +562 -0
- package/dist/lib/commands/config.d.ts.map +1 -0
- package/dist/lib/commands/config.js +416 -0
- package/dist/lib/commands/config.js.map +1 -0
- package/dist/lib/commands/db.d.ts +34 -0
- package/dist/lib/commands/db.d.ts.map +1 -0
- package/dist/lib/commands/db.js +247 -0
- package/dist/lib/commands/db.js.map +1 -0
- package/dist/lib/commands/errors.d.ts +68 -0
- package/dist/lib/commands/errors.d.ts.map +1 -0
- package/dist/lib/commands/errors.js +72 -0
- package/dist/lib/commands/errors.js.map +1 -0
- package/dist/lib/commands/init.d.ts.map +1 -1
- package/dist/lib/commands/init.js +15 -14
- package/dist/lib/commands/init.js.map +1 -1
- package/dist/lib/commands/pull.d.ts +104 -2
- package/dist/lib/commands/pull.d.ts.map +1 -1
- package/dist/lib/commands/pull.js +470 -281
- package/dist/lib/commands/pull.js.map +1 -1
- package/dist/lib/commands/push.d.ts +106 -0
- package/dist/lib/commands/push.d.ts.map +1 -1
- package/dist/lib/commands/push.js +1257 -1628
- package/dist/lib/commands/push.js.map +1 -1
- package/dist/lib/commands/run.js +1 -1
- package/dist/lib/commands/run.js.map +1 -1
- package/dist/lib/commands/schema.d.ts +59 -0
- package/dist/lib/commands/schema.d.ts.map +1 -0
- package/dist/lib/commands/schema.js +86 -0
- package/dist/lib/commands/schema.js.map +1 -0
- package/dist/lib/commands/services/account.d.ts.map +1 -1
- package/dist/lib/commands/services/account.js +86 -64
- package/dist/lib/commands/services/account.js.map +1 -1
- package/dist/lib/commands/services/console.d.ts.map +1 -1
- package/dist/lib/commands/services/console.js +4 -17
- package/dist/lib/commands/services/console.js.map +1 -1
- package/dist/lib/commands/services/databases.d.ts.map +1 -1
- package/dist/lib/commands/services/databases.js +160 -152
- package/dist/lib/commands/services/databases.js.map +1 -1
- package/dist/lib/commands/services/functions.d.ts.map +1 -1
- package/dist/lib/commands/services/functions.js +41 -33
- package/dist/lib/commands/services/functions.js.map +1 -1
- package/dist/lib/commands/services/graphql.d.ts.map +1 -1
- package/dist/lib/commands/services/graphql.js +3 -3
- package/dist/lib/commands/services/graphql.js.map +1 -1
- package/dist/lib/commands/services/health.d.ts.map +1 -1
- package/dist/lib/commands/services/health.js +24 -24
- package/dist/lib/commands/services/health.js.map +1 -1
- package/dist/lib/commands/services/locale.d.ts.map +1 -1
- package/dist/lib/commands/services/locale.js +9 -9
- package/dist/lib/commands/services/locale.js.map +1 -1
- package/dist/lib/commands/services/messaging.d.ts.map +1 -1
- package/dist/lib/commands/services/messaging.js +59 -59
- package/dist/lib/commands/services/messaging.js.map +1 -1
- package/dist/lib/commands/services/migrations.d.ts.map +1 -1
- package/dist/lib/commands/services/migrations.js +19 -19
- package/dist/lib/commands/services/migrations.js.map +1 -1
- package/dist/lib/commands/services/project.d.ts.map +1 -1
- package/dist/lib/commands/services/project.js +8 -8
- package/dist/lib/commands/services/project.js.map +1 -1
- package/dist/lib/commands/services/projects.d.ts.map +1 -1
- package/dist/lib/commands/services/projects.js +64 -64
- package/dist/lib/commands/services/projects.js.map +1 -1
- package/dist/lib/commands/services/proxy.d.ts.map +1 -1
- package/dist/lib/commands/services/proxy.js +11 -11
- package/dist/lib/commands/services/proxy.js.map +1 -1
- package/dist/lib/commands/services/sites.d.ts.map +1 -1
- package/dist/lib/commands/services/sites.js +41 -33
- package/dist/lib/commands/services/sites.js.map +1 -1
- package/dist/lib/commands/services/storage.d.ts.map +1 -1
- package/dist/lib/commands/services/storage.js +38 -16
- package/dist/lib/commands/services/storage.js.map +1 -1
- package/dist/lib/commands/services/tables-db.d.ts +3 -0
- package/dist/lib/commands/services/tables-db.d.ts.map +1 -0
- package/dist/lib/commands/services/{tablesdb.js → tables-db.js} +171 -163
- package/dist/lib/commands/services/tables-db.js.map +1 -0
- package/dist/lib/commands/services/teams.d.ts.map +1 -1
- package/dist/lib/commands/services/teams.js +16 -16
- package/dist/lib/commands/services/teams.js.map +1 -1
- package/dist/lib/commands/services/tokens.d.ts.map +1 -1
- package/dist/lib/commands/services/tokens.js +6 -6
- package/dist/lib/commands/services/tokens.js.map +1 -1
- package/dist/lib/commands/services/users.d.ts.map +1 -1
- package/dist/lib/commands/services/users.js +54 -54
- package/dist/lib/commands/services/users.js.map +1 -1
- package/dist/lib/commands/services/vcs.d.ts.map +1 -1
- package/dist/lib/commands/services/vcs.js +13 -13
- package/dist/lib/commands/services/vcs.js.map +1 -1
- package/dist/lib/commands/types.d.ts.map +1 -1
- package/dist/lib/commands/types.js +1 -1
- package/dist/lib/commands/types.js.map +1 -1
- package/dist/lib/commands/update.d.ts.map +1 -1
- package/dist/lib/commands/update.js +9 -8
- package/dist/lib/commands/update.js.map +1 -1
- package/dist/lib/commands/utils/attributes.d.ts +47 -0
- package/dist/lib/commands/utils/attributes.d.ts.map +1 -0
- package/dist/lib/commands/utils/attributes.js +514 -0
- package/dist/lib/commands/utils/attributes.js.map +1 -0
- package/dist/lib/commands/utils/change-approval.d.ts +25 -0
- package/dist/lib/commands/utils/change-approval.d.ts.map +1 -0
- package/dist/lib/commands/utils/change-approval.js +129 -0
- package/dist/lib/commands/utils/change-approval.js.map +1 -0
- package/dist/lib/commands/utils/database-sync.d.ts +10 -0
- package/dist/lib/commands/utils/database-sync.d.ts.map +1 -0
- package/dist/lib/commands/utils/database-sync.js +136 -0
- package/dist/lib/commands/utils/database-sync.js.map +1 -0
- package/dist/lib/commands/utils/deployment.d.ts +34 -0
- package/dist/lib/commands/utils/deployment.d.ts.map +1 -0
- package/dist/lib/commands/utils/deployment.js +109 -0
- package/dist/lib/commands/utils/deployment.js.map +1 -0
- package/dist/lib/commands/utils/error-formatter.d.ts +19 -0
- package/dist/lib/commands/utils/error-formatter.d.ts.map +1 -0
- package/dist/lib/commands/utils/error-formatter.js +333 -0
- package/dist/lib/commands/utils/error-formatter.js.map +1 -0
- package/dist/lib/commands/utils/pools.d.ts +16 -0
- package/dist/lib/commands/utils/pools.d.ts.map +1 -0
- package/dist/lib/commands/utils/pools.js +198 -0
- package/dist/lib/commands/utils/pools.js.map +1 -0
- package/dist/lib/config.d.ts +27 -26
- package/dist/lib/config.d.ts.map +1 -1
- package/dist/lib/config.js +8 -45
- package/dist/lib/config.js.map +1 -1
- package/dist/lib/constants.d.ts +14 -0
- package/dist/lib/constants.d.ts.map +1 -0
- package/dist/lib/constants.js +19 -0
- package/dist/lib/constants.js.map +1 -0
- package/dist/lib/emulation/docker.d.ts +4 -4
- package/dist/lib/emulation/docker.d.ts.map +1 -1
- package/dist/lib/emulation/docker.js +80 -67
- package/dist/lib/emulation/docker.js.map +1 -1
- package/dist/lib/parser.d.ts.map +1 -1
- package/dist/lib/parser.js +11 -10
- package/dist/lib/parser.js.map +1 -1
- package/dist/lib/questions.d.ts.map +1 -1
- package/dist/lib/questions.js +20 -20
- package/dist/lib/questions.js.map +1 -1
- package/dist/lib/sdks.d.ts.map +1 -1
- package/dist/lib/sdks.js +10 -11
- package/dist/lib/sdks.js.map +1 -1
- package/dist/lib/types.d.ts +0 -214
- package/dist/lib/types.d.ts.map +1 -1
- package/dist/lib/utils.d.ts +3 -0
- package/dist/lib/utils.d.ts.map +1 -1
- package/dist/lib/utils.js +42 -2
- package/dist/lib/utils.js.map +1 -1
- package/dist/package.json +12 -11
- package/docs/examples/account/create-anonymous-session.md +1 -0
- package/docs/examples/account/create-email-password-session.md +3 -0
- package/docs/examples/account/create-email-token.md +3 -0
- package/docs/examples/account/create-email-verification.md +2 -0
- package/docs/examples/account/create-jwt.md +1 -0
- package/docs/examples/account/create-magic-url-token.md +3 -0
- package/docs/examples/account/create-mfa-authenticator.md +2 -0
- package/docs/examples/account/create-mfa-challenge.md +2 -0
- package/docs/examples/account/create-mfa-recovery-codes.md +1 -0
- package/docs/examples/account/create-o-auth-2-session.md +2 -0
- package/docs/examples/account/create-o-auth-2-token.md +2 -0
- package/docs/examples/account/create-phone-token.md +3 -0
- package/docs/examples/account/create-phone-verification.md +1 -0
- package/docs/examples/account/create-push-target.md +3 -0
- package/docs/examples/account/create-recovery.md +3 -0
- package/docs/examples/account/create-session.md +3 -0
- package/docs/examples/account/create-verification.md +2 -0
- package/docs/examples/account/create.md +4 -0
- package/docs/examples/account/delete-identity.md +2 -0
- package/docs/examples/account/delete-mfa-authenticator.md +2 -0
- package/docs/examples/account/delete-push-target.md +2 -0
- package/docs/examples/account/delete-session.md +2 -0
- package/docs/examples/account/delete-sessions.md +1 -0
- package/docs/examples/account/delete.md +1 -0
- package/docs/examples/account/get-mfa-recovery-codes.md +1 -0
- package/docs/examples/account/get-prefs.md +1 -0
- package/docs/examples/account/get-session.md +2 -0
- package/docs/examples/account/get.md +1 -0
- package/docs/examples/account/list-identities.md +1 -0
- package/docs/examples/account/list-logs.md +1 -0
- package/docs/examples/account/list-mfa-factors.md +1 -0
- package/docs/examples/account/list-sessions.md +1 -0
- package/docs/examples/account/update-email-verification.md +3 -0
- package/docs/examples/account/update-email.md +3 -0
- package/docs/examples/account/update-magic-url-session.md +3 -0
- package/docs/examples/account/update-mfa-authenticator.md +3 -0
- package/docs/examples/account/update-mfa-challenge.md +3 -0
- package/docs/examples/account/update-mfa-recovery-codes.md +1 -0
- package/docs/examples/account/update-mfa.md +2 -0
- package/docs/examples/account/update-name.md +2 -0
- package/docs/examples/account/update-password.md +2 -0
- package/docs/examples/account/update-phone-session.md +3 -0
- package/docs/examples/account/update-phone-verification.md +3 -0
- package/docs/examples/account/update-phone.md +3 -0
- package/docs/examples/account/update-prefs.md +2 -0
- package/docs/examples/account/update-push-target.md +3 -0
- package/docs/examples/account/update-recovery.md +4 -0
- package/docs/examples/account/update-session.md +2 -0
- package/docs/examples/account/update-status.md +1 -0
- package/docs/examples/account/update-verification.md +3 -0
- package/docs/examples/console/get-resource.md +3 -0
- package/docs/examples/console/variables.md +1 -0
- package/docs/examples/databases/create-boolean-attribute.md +5 -0
- package/docs/examples/databases/create-collection.md +4 -0
- package/docs/examples/databases/create-datetime-attribute.md +5 -0
- package/docs/examples/databases/create-document.md +5 -0
- package/docs/examples/databases/create-documents.md +4 -0
- package/docs/examples/databases/create-email-attribute.md +5 -0
- package/docs/examples/databases/create-enum-attribute.md +6 -0
- package/docs/examples/databases/create-float-attribute.md +5 -0
- package/docs/examples/databases/create-index.md +6 -0
- package/docs/examples/databases/create-integer-attribute.md +5 -0
- package/docs/examples/databases/create-ip-attribute.md +5 -0
- package/docs/examples/databases/create-line-attribute.md +5 -0
- package/docs/examples/databases/create-operations.md +2 -0
- package/docs/examples/databases/create-point-attribute.md +5 -0
- package/docs/examples/databases/create-polygon-attribute.md +5 -0
- package/docs/examples/databases/create-relationship-attribute.md +5 -0
- package/docs/examples/databases/create-string-attribute.md +6 -0
- package/docs/examples/databases/create-transaction.md +1 -0
- package/docs/examples/databases/create-url-attribute.md +5 -0
- package/docs/examples/databases/create.md +3 -0
- package/docs/examples/databases/decrement-document-attribute.md +5 -0
- package/docs/examples/databases/delete-attribute.md +4 -0
- package/docs/examples/databases/delete-collection.md +3 -0
- package/docs/examples/databases/delete-document.md +4 -0
- package/docs/examples/databases/delete-documents.md +3 -0
- package/docs/examples/databases/delete-index.md +4 -0
- package/docs/examples/databases/delete-transaction.md +2 -0
- package/docs/examples/databases/delete.md +2 -0
- package/docs/examples/databases/get-attribute.md +4 -0
- package/docs/examples/databases/get-collection-usage.md +3 -0
- package/docs/examples/databases/get-collection.md +3 -0
- package/docs/examples/databases/get-document.md +4 -0
- package/docs/examples/databases/get-index.md +4 -0
- package/docs/examples/databases/get-transaction.md +2 -0
- package/docs/examples/databases/get-usage.md +2 -0
- package/docs/examples/databases/get.md +2 -0
- package/docs/examples/databases/increment-document-attribute.md +5 -0
- package/docs/examples/databases/list-attributes.md +3 -0
- package/docs/examples/databases/list-collection-logs.md +3 -0
- package/docs/examples/databases/list-collections.md +2 -0
- package/docs/examples/databases/list-document-logs.md +4 -0
- package/docs/examples/databases/list-documents.md +3 -0
- package/docs/examples/databases/list-indexes.md +3 -0
- package/docs/examples/databases/list-logs.md +2 -0
- package/docs/examples/databases/list-transactions.md +1 -0
- package/docs/examples/databases/list-usage.md +1 -0
- package/docs/examples/databases/list.md +1 -0
- package/docs/examples/databases/update-boolean-attribute.md +6 -0
- package/docs/examples/databases/update-collection.md +4 -0
- package/docs/examples/databases/update-datetime-attribute.md +6 -0
- package/docs/examples/databases/update-document.md +4 -0
- package/docs/examples/databases/update-documents.md +3 -0
- package/docs/examples/databases/update-email-attribute.md +6 -0
- package/docs/examples/databases/update-enum-attribute.md +7 -0
- package/docs/examples/databases/update-float-attribute.md +6 -0
- package/docs/examples/databases/update-integer-attribute.md +6 -0
- package/docs/examples/databases/update-ip-attribute.md +6 -0
- package/docs/examples/databases/update-line-attribute.md +5 -0
- package/docs/examples/databases/update-point-attribute.md +5 -0
- package/docs/examples/databases/update-polygon-attribute.md +5 -0
- package/docs/examples/databases/update-relationship-attribute.md +4 -0
- package/docs/examples/databases/update-string-attribute.md +6 -0
- package/docs/examples/databases/update-transaction.md +2 -0
- package/docs/examples/databases/update-url-attribute.md +6 -0
- package/docs/examples/databases/update.md +3 -0
- package/docs/examples/databases/upsert-document.md +4 -0
- package/docs/examples/databases/upsert-documents.md +4 -0
- package/docs/examples/functions/create-deployment.md +4 -0
- package/docs/examples/functions/create-duplicate-deployment.md +3 -0
- package/docs/examples/functions/create-execution.md +2 -0
- package/docs/examples/functions/create-template-deployment.md +7 -0
- package/docs/examples/functions/create-variable.md +4 -0
- package/docs/examples/functions/create-vcs-deployment.md +4 -0
- package/docs/examples/functions/create.md +4 -0
- package/docs/examples/functions/delete-deployment.md +3 -0
- package/docs/examples/functions/delete-execution.md +3 -0
- package/docs/examples/functions/delete-variable.md +3 -0
- package/docs/examples/functions/delete.md +2 -0
- package/docs/examples/functions/get-deployment-download.md +3 -0
- package/docs/examples/functions/get-deployment.md +3 -0
- package/docs/examples/functions/get-execution.md +3 -0
- package/docs/examples/functions/get-template.md +2 -0
- package/docs/examples/functions/get-usage.md +2 -0
- package/docs/examples/functions/get-variable.md +3 -0
- package/docs/examples/functions/get.md +2 -0
- package/docs/examples/functions/list-deployments.md +2 -0
- package/docs/examples/functions/list-executions.md +2 -0
- package/docs/examples/functions/list-runtimes.md +1 -0
- package/docs/examples/functions/list-specifications.md +1 -0
- package/docs/examples/functions/list-templates.md +1 -0
- package/docs/examples/functions/list-usage.md +1 -0
- package/docs/examples/functions/list-variables.md +2 -0
- package/docs/examples/functions/list.md +1 -0
- package/docs/examples/functions/update-deployment-status.md +3 -0
- package/docs/examples/functions/update-function-deployment.md +3 -0
- package/docs/examples/functions/update-variable.md +4 -0
- package/docs/examples/functions/update.md +3 -0
- package/docs/examples/graphql/mutation.md +2 -0
- package/docs/examples/graphql/query.md +2 -0
- package/docs/examples/health/get-antivirus.md +1 -0
- package/docs/examples/health/get-cache.md +1 -0
- package/docs/examples/health/get-certificate.md +1 -0
- package/docs/examples/health/get-db.md +1 -0
- package/docs/examples/health/get-failed-jobs.md +2 -0
- package/docs/examples/health/get-pub-sub.md +1 -0
- package/docs/examples/health/get-queue-builds.md +1 -0
- package/docs/examples/health/get-queue-certificates.md +1 -0
- package/docs/examples/health/get-queue-databases.md +1 -0
- package/docs/examples/health/get-queue-deletes.md +1 -0
- package/docs/examples/health/get-queue-functions.md +1 -0
- package/docs/examples/health/get-queue-logs.md +1 -0
- package/docs/examples/health/get-queue-mails.md +1 -0
- package/docs/examples/health/get-queue-messaging.md +1 -0
- package/docs/examples/health/get-queue-migrations.md +1 -0
- package/docs/examples/health/get-queue-stats-resources.md +1 -0
- package/docs/examples/health/get-queue-usage.md +1 -0
- package/docs/examples/health/get-queue-webhooks.md +1 -0
- package/docs/examples/health/get-storage-local.md +1 -0
- package/docs/examples/health/get-storage.md +1 -0
- package/docs/examples/health/get-time.md +1 -0
- package/docs/examples/health/get.md +1 -0
- package/docs/examples/locale/get.md +1 -0
- package/docs/examples/locale/list-codes.md +1 -0
- package/docs/examples/locale/list-continents.md +1 -0
- package/docs/examples/locale/list-countries-eu.md +1 -0
- package/docs/examples/locale/list-countries-phones.md +1 -0
- package/docs/examples/locale/list-countries.md +1 -0
- package/docs/examples/locale/list-currencies.md +1 -0
- package/docs/examples/locale/list-languages.md +1 -0
- package/docs/examples/messaging/create-apns-provider.md +3 -0
- package/docs/examples/messaging/create-email.md +4 -0
- package/docs/examples/messaging/create-fcm-provider.md +3 -0
- package/docs/examples/messaging/create-mailgun-provider.md +3 -0
- package/docs/examples/messaging/create-msg-91-provider.md +3 -0
- package/docs/examples/messaging/create-push.md +2 -0
- package/docs/examples/messaging/create-resend-provider.md +3 -0
- package/docs/examples/messaging/create-sendgrid-provider.md +3 -0
- package/docs/examples/messaging/create-sms.md +3 -0
- package/docs/examples/messaging/create-smtp-provider.md +4 -0
- package/docs/examples/messaging/create-subscriber.md +4 -0
- package/docs/examples/messaging/create-telesign-provider.md +3 -0
- package/docs/examples/messaging/create-textmagic-provider.md +3 -0
- package/docs/examples/messaging/create-topic.md +3 -0
- package/docs/examples/messaging/create-twilio-provider.md +3 -0
- package/docs/examples/messaging/create-vonage-provider.md +3 -0
- package/docs/examples/messaging/delete-provider.md +2 -0
- package/docs/examples/messaging/delete-subscriber.md +3 -0
- package/docs/examples/messaging/delete-topic.md +2 -0
- package/docs/examples/messaging/delete.md +2 -0
- package/docs/examples/messaging/get-message.md +2 -0
- package/docs/examples/messaging/get-provider.md +2 -0
- package/docs/examples/messaging/get-subscriber.md +3 -0
- package/docs/examples/messaging/get-topic.md +2 -0
- package/docs/examples/messaging/list-message-logs.md +2 -0
- package/docs/examples/messaging/list-messages.md +1 -0
- package/docs/examples/messaging/list-provider-logs.md +2 -0
- package/docs/examples/messaging/list-providers.md +1 -0
- package/docs/examples/messaging/list-subscriber-logs.md +2 -0
- package/docs/examples/messaging/list-subscribers.md +2 -0
- package/docs/examples/messaging/list-targets.md +2 -0
- package/docs/examples/messaging/list-topic-logs.md +2 -0
- package/docs/examples/messaging/list-topics.md +1 -0
- package/docs/examples/messaging/update-apns-provider.md +2 -0
- package/docs/examples/messaging/update-email.md +2 -0
- package/docs/examples/messaging/update-fcm-provider.md +2 -0
- package/docs/examples/messaging/update-mailgun-provider.md +2 -0
- package/docs/examples/messaging/update-msg-91-provider.md +2 -0
- package/docs/examples/messaging/update-push.md +2 -0
- package/docs/examples/messaging/update-resend-provider.md +2 -0
- package/docs/examples/messaging/update-sendgrid-provider.md +2 -0
- package/docs/examples/messaging/update-sms.md +2 -0
- package/docs/examples/messaging/update-smtp-provider.md +2 -0
- package/docs/examples/messaging/update-telesign-provider.md +2 -0
- package/docs/examples/messaging/update-textmagic-provider.md +2 -0
- package/docs/examples/messaging/update-topic.md +2 -0
- package/docs/examples/messaging/update-twilio-provider.md +2 -0
- package/docs/examples/messaging/update-vonage-provider.md +2 -0
- package/docs/examples/migrations/create-appwrite-migration.md +5 -0
- package/docs/examples/migrations/create-csv-export.md +3 -0
- package/docs/examples/migrations/create-csv-import.md +4 -0
- package/docs/examples/migrations/create-firebase-migration.md +3 -0
- package/docs/examples/migrations/create-n-host-migration.md +8 -0
- package/docs/examples/migrations/create-supabase-migration.md +7 -0
- package/docs/examples/migrations/delete.md +2 -0
- package/docs/examples/migrations/get-appwrite-report.md +5 -0
- package/docs/examples/migrations/get-firebase-report.md +3 -0
- package/docs/examples/migrations/get-n-host-report.md +8 -0
- package/docs/examples/migrations/get-supabase-report.md +7 -0
- package/docs/examples/migrations/get.md +2 -0
- package/docs/examples/migrations/list.md +1 -0
- package/docs/examples/migrations/retry.md +2 -0
- package/docs/examples/project/create-variable.md +3 -0
- package/docs/examples/project/delete-variable.md +2 -0
- package/docs/examples/project/get-usage.md +3 -0
- package/docs/examples/project/get-variable.md +2 -0
- package/docs/examples/project/list-variables.md +1 -0
- package/docs/examples/project/update-variable.md +3 -0
- package/docs/examples/projects/create-dev-key.md +4 -0
- package/docs/examples/projects/create-jwt.md +3 -0
- package/docs/examples/projects/create-key.md +4 -0
- package/docs/examples/projects/create-platform.md +4 -0
- package/docs/examples/projects/create-smtp-test.md +6 -0
- package/docs/examples/projects/create-webhook.md +6 -0
- package/docs/examples/projects/create.md +4 -0
- package/docs/examples/projects/delete-dev-key.md +3 -0
- package/docs/examples/projects/delete-email-template.md +4 -0
- package/docs/examples/projects/delete-key.md +3 -0
- package/docs/examples/projects/delete-platform.md +3 -0
- package/docs/examples/projects/delete-sms-template.md +4 -0
- package/docs/examples/projects/delete-webhook.md +3 -0
- package/docs/examples/projects/delete.md +2 -0
- package/docs/examples/projects/get-dev-key.md +3 -0
- package/docs/examples/projects/get-email-template.md +4 -0
- package/docs/examples/projects/get-key.md +3 -0
- package/docs/examples/projects/get-platform.md +3 -0
- package/docs/examples/projects/get-sms-template.md +4 -0
- package/docs/examples/projects/get-webhook.md +3 -0
- package/docs/examples/projects/get.md +2 -0
- package/docs/examples/projects/list-dev-keys.md +2 -0
- package/docs/examples/projects/list-keys.md +2 -0
- package/docs/examples/projects/list-platforms.md +2 -0
- package/docs/examples/projects/list-webhooks.md +2 -0
- package/docs/examples/projects/list.md +1 -0
- package/docs/examples/projects/update-api-status-all.md +3 -0
- package/docs/examples/projects/update-api-status.md +4 -0
- package/docs/examples/projects/update-auth-duration.md +3 -0
- package/docs/examples/projects/update-auth-limit.md +3 -0
- package/docs/examples/projects/update-auth-password-dictionary.md +3 -0
- package/docs/examples/projects/update-auth-password-history.md +3 -0
- package/docs/examples/projects/update-auth-sessions-limit.md +3 -0
- package/docs/examples/projects/update-auth-status.md +4 -0
- package/docs/examples/projects/update-dev-key.md +5 -0
- package/docs/examples/projects/update-email-template.md +6 -0
- package/docs/examples/projects/update-key.md +5 -0
- package/docs/examples/projects/update-memberships-privacy.md +5 -0
- package/docs/examples/projects/update-mock-numbers.md +3 -0
- package/docs/examples/projects/update-o-auth-2.md +3 -0
- package/docs/examples/projects/update-personal-data-check.md +3 -0
- package/docs/examples/projects/update-platform.md +4 -0
- package/docs/examples/projects/update-service-status-all.md +3 -0
- package/docs/examples/projects/update-service-status.md +4 -0
- package/docs/examples/projects/update-session-alerts.md +3 -0
- package/docs/examples/projects/update-session-invalidation.md +3 -0
- package/docs/examples/projects/update-sms-template.md +5 -0
- package/docs/examples/projects/update-smtp.md +3 -0
- package/docs/examples/projects/update-team.md +3 -0
- package/docs/examples/projects/update-webhook-signature.md +3 -0
- package/docs/examples/projects/update-webhook.md +7 -0
- package/docs/examples/projects/update.md +3 -0
- package/docs/examples/proxy/create-api-rule.md +2 -0
- package/docs/examples/proxy/create-function-rule.md +3 -0
- package/docs/examples/proxy/create-redirect-rule.md +6 -0
- package/docs/examples/proxy/create-site-rule.md +3 -0
- package/docs/examples/proxy/delete-rule.md +2 -0
- package/docs/examples/proxy/get-rule.md +2 -0
- package/docs/examples/proxy/list-rules.md +1 -0
- package/docs/examples/proxy/update-rule-verification.md +2 -0
- package/docs/examples/sites/create-deployment.md +4 -0
- package/docs/examples/sites/create-duplicate-deployment.md +3 -0
- package/docs/examples/sites/create-template-deployment.md +7 -0
- package/docs/examples/sites/create-variable.md +4 -0
- package/docs/examples/sites/create-vcs-deployment.md +4 -0
- package/docs/examples/sites/create.md +5 -0
- package/docs/examples/sites/delete-deployment.md +3 -0
- package/docs/examples/sites/delete-log.md +3 -0
- package/docs/examples/sites/delete-variable.md +3 -0
- package/docs/examples/sites/delete.md +2 -0
- package/docs/examples/sites/get-deployment-download.md +3 -0
- package/docs/examples/sites/get-deployment.md +3 -0
- package/docs/examples/sites/get-log.md +3 -0
- package/docs/examples/sites/get-template.md +2 -0
- package/docs/examples/sites/get-usage.md +2 -0
- package/docs/examples/sites/get-variable.md +3 -0
- package/docs/examples/sites/get.md +2 -0
- package/docs/examples/sites/list-deployments.md +2 -0
- package/docs/examples/sites/list-frameworks.md +1 -0
- package/docs/examples/sites/list-logs.md +2 -0
- package/docs/examples/sites/list-specifications.md +1 -0
- package/docs/examples/sites/list-templates.md +1 -0
- package/docs/examples/sites/list-usage.md +1 -0
- package/docs/examples/sites/list-variables.md +2 -0
- package/docs/examples/sites/list.md +1 -0
- package/docs/examples/sites/update-deployment-status.md +3 -0
- package/docs/examples/sites/update-site-deployment.md +3 -0
- package/docs/examples/sites/update-variable.md +4 -0
- package/docs/examples/sites/update.md +4 -0
- package/docs/examples/storage/create-bucket.md +3 -0
- package/docs/examples/storage/create-file.md +4 -0
- package/docs/examples/storage/delete-bucket.md +2 -0
- package/docs/examples/storage/delete-file.md +3 -0
- package/docs/examples/storage/get-bucket-usage.md +2 -0
- package/docs/examples/storage/get-bucket.md +2 -0
- package/docs/examples/storage/get-file-download.md +3 -0
- package/docs/examples/storage/get-file-preview.md +3 -0
- package/docs/examples/storage/get-file-view.md +3 -0
- package/docs/examples/storage/get-file.md +3 -0
- package/docs/examples/storage/get-usage.md +1 -0
- package/docs/examples/storage/list-buckets.md +1 -0
- package/docs/examples/storage/list-files.md +2 -0
- package/docs/examples/storage/update-bucket.md +3 -0
- package/docs/examples/storage/update-file.md +3 -0
- package/docs/examples/tablesdb/create-boolean-column.md +5 -0
- package/docs/examples/tablesdb/create-datetime-column.md +5 -0
- package/docs/examples/tablesdb/create-email-column.md +5 -0
- package/docs/examples/tablesdb/create-enum-column.md +6 -0
- package/docs/examples/tablesdb/create-float-column.md +5 -0
- package/docs/examples/tablesdb/create-index.md +6 -0
- package/docs/examples/tablesdb/create-integer-column.md +5 -0
- package/docs/examples/tablesdb/create-ip-column.md +5 -0
- package/docs/examples/tablesdb/create-line-column.md +5 -0
- package/docs/examples/tablesdb/create-operations.md +2 -0
- package/docs/examples/tablesdb/create-point-column.md +5 -0
- package/docs/examples/tablesdb/create-polygon-column.md +5 -0
- package/docs/examples/tablesdb/create-relationship-column.md +5 -0
- package/docs/examples/tablesdb/create-row.md +5 -0
- package/docs/examples/tablesdb/create-rows.md +4 -0
- package/docs/examples/tablesdb/create-string-column.md +6 -0
- package/docs/examples/tablesdb/create-table.md +4 -0
- package/docs/examples/tablesdb/create-transaction.md +1 -0
- package/docs/examples/tablesdb/create-url-column.md +5 -0
- package/docs/examples/tablesdb/create.md +3 -0
- package/docs/examples/tablesdb/decrement-row-column.md +5 -0
- package/docs/examples/tablesdb/delete-column.md +4 -0
- package/docs/examples/tablesdb/delete-index.md +4 -0
- package/docs/examples/tablesdb/delete-row.md +4 -0
- package/docs/examples/tablesdb/delete-rows.md +3 -0
- package/docs/examples/tablesdb/delete-table.md +3 -0
- package/docs/examples/tablesdb/delete-transaction.md +2 -0
- package/docs/examples/tablesdb/delete.md +2 -0
- package/docs/examples/tablesdb/get-column.md +4 -0
- package/docs/examples/tablesdb/get-index.md +4 -0
- package/docs/examples/tablesdb/get-row.md +4 -0
- package/docs/examples/tablesdb/get-table-usage.md +3 -0
- package/docs/examples/tablesdb/get-table.md +3 -0
- package/docs/examples/tablesdb/get-transaction.md +2 -0
- package/docs/examples/tablesdb/get-usage.md +2 -0
- package/docs/examples/tablesdb/get.md +2 -0
- package/docs/examples/tablesdb/increment-row-column.md +5 -0
- package/docs/examples/tablesdb/list-columns.md +3 -0
- package/docs/examples/tablesdb/list-indexes.md +3 -0
- package/docs/examples/tablesdb/list-row-logs.md +4 -0
- package/docs/examples/tablesdb/list-rows.md +3 -0
- package/docs/examples/tablesdb/list-table-logs.md +3 -0
- package/docs/examples/tablesdb/list-tables.md +2 -0
- package/docs/examples/tablesdb/list-transactions.md +1 -0
- package/docs/examples/tablesdb/list-usage.md +1 -0
- package/docs/examples/tablesdb/list.md +1 -0
- package/docs/examples/tablesdb/update-boolean-column.md +6 -0
- package/docs/examples/tablesdb/update-datetime-column.md +6 -0
- package/docs/examples/tablesdb/update-email-column.md +6 -0
- package/docs/examples/tablesdb/update-enum-column.md +7 -0
- package/docs/examples/tablesdb/update-float-column.md +6 -0
- package/docs/examples/tablesdb/update-integer-column.md +6 -0
- package/docs/examples/tablesdb/update-ip-column.md +6 -0
- package/docs/examples/tablesdb/update-line-column.md +5 -0
- package/docs/examples/tablesdb/update-point-column.md +5 -0
- package/docs/examples/tablesdb/update-polygon-column.md +5 -0
- package/docs/examples/tablesdb/update-relationship-column.md +4 -0
- package/docs/examples/tablesdb/update-row.md +4 -0
- package/docs/examples/tablesdb/update-rows.md +3 -0
- package/docs/examples/tablesdb/update-string-column.md +6 -0
- package/docs/examples/tablesdb/update-table.md +4 -0
- package/docs/examples/tablesdb/update-transaction.md +2 -0
- package/docs/examples/tablesdb/update-url-column.md +6 -0
- package/docs/examples/tablesdb/update.md +3 -0
- package/docs/examples/tablesdb/upsert-row.md +4 -0
- package/docs/examples/tablesdb/upsert-rows.md +4 -0
- package/docs/examples/teams/create-membership.md +3 -0
- package/docs/examples/teams/create.md +3 -0
- package/docs/examples/teams/delete-membership.md +3 -0
- package/docs/examples/teams/delete.md +2 -0
- package/docs/examples/teams/get-membership.md +3 -0
- package/docs/examples/teams/get-prefs.md +2 -0
- package/docs/examples/teams/get.md +2 -0
- package/docs/examples/teams/list-logs.md +2 -0
- package/docs/examples/teams/list-memberships.md +2 -0
- package/docs/examples/teams/list.md +1 -0
- package/docs/examples/teams/update-membership-status.md +5 -0
- package/docs/examples/teams/update-membership.md +4 -0
- package/docs/examples/teams/update-name.md +3 -0
- package/docs/examples/teams/update-prefs.md +3 -0
- package/docs/examples/tokens/create-file-token.md +3 -0
- package/docs/examples/tokens/delete.md +2 -0
- package/docs/examples/tokens/get.md +2 -0
- package/docs/examples/tokens/list.md +3 -0
- package/docs/examples/tokens/update.md +2 -0
- package/docs/examples/users/create-argon-2-user.md +4 -0
- package/docs/examples/users/create-bcrypt-user.md +4 -0
- package/docs/examples/users/create-jwt.md +2 -0
- package/docs/examples/users/create-md-5-user.md +4 -0
- package/docs/examples/users/create-mfa-recovery-codes.md +2 -0
- package/docs/examples/users/create-ph-pass-user.md +4 -0
- package/docs/examples/users/create-scrypt-modified-user.md +7 -0
- package/docs/examples/users/create-scrypt-user.md +9 -0
- package/docs/examples/users/create-session.md +2 -0
- package/docs/examples/users/create-sha-user.md +4 -0
- package/docs/examples/users/create-target.md +5 -0
- package/docs/examples/users/create-token.md +2 -0
- package/docs/examples/users/create.md +2 -0
- package/docs/examples/users/delete-identity.md +2 -0
- package/docs/examples/users/delete-mfa-authenticator.md +3 -0
- package/docs/examples/users/delete-session.md +3 -0
- package/docs/examples/users/delete-sessions.md +2 -0
- package/docs/examples/users/delete-target.md +3 -0
- package/docs/examples/users/delete.md +2 -0
- package/docs/examples/users/get-mfa-recovery-codes.md +2 -0
- package/docs/examples/users/get-prefs.md +2 -0
- package/docs/examples/users/get-target.md +3 -0
- package/docs/examples/users/get-usage.md +1 -0
- package/docs/examples/users/get.md +2 -0
- package/docs/examples/users/list-identities.md +1 -0
- package/docs/examples/users/list-logs.md +2 -0
- package/docs/examples/users/list-memberships.md +2 -0
- package/docs/examples/users/list-mfa-factors.md +2 -0
- package/docs/examples/users/list-sessions.md +2 -0
- package/docs/examples/users/list-targets.md +2 -0
- package/docs/examples/users/list.md +1 -0
- package/docs/examples/users/update-email-verification.md +3 -0
- package/docs/examples/users/update-email.md +3 -0
- package/docs/examples/users/update-labels.md +3 -0
- package/docs/examples/users/update-mfa-recovery-codes.md +2 -0
- package/docs/examples/users/update-mfa.md +3 -0
- package/docs/examples/users/update-name.md +3 -0
- package/docs/examples/users/update-password.md +3 -0
- package/docs/examples/users/update-phone-verification.md +3 -0
- package/docs/examples/users/update-phone.md +3 -0
- package/docs/examples/users/update-prefs.md +3 -0
- package/docs/examples/users/update-status.md +3 -0
- package/docs/examples/users/update-target.md +3 -0
- package/docs/examples/vcs/create-repository-detection.md +4 -0
- package/docs/examples/vcs/create-repository.md +4 -0
- package/docs/examples/vcs/delete-installation.md +2 -0
- package/docs/examples/vcs/get-installation.md +2 -0
- package/docs/examples/vcs/get-repository-contents.md +3 -0
- package/docs/examples/vcs/get-repository.md +3 -0
- package/docs/examples/vcs/list-installations.md +1 -0
- package/docs/examples/vcs/list-repositories.md +3 -0
- package/docs/examples/vcs/list-repository-branches.md +3 -0
- package/docs/examples/vcs/update-external-deployments.md +4 -0
- package/index.ts +25 -165
- package/install.ps1 +2 -2
- package/install.sh +1 -1
- package/lib/client.ts +14 -6
- package/lib/commands/config.ts +494 -0
- package/lib/commands/db.ts +324 -0
- package/lib/commands/errors.ts +93 -0
- package/lib/commands/init.ts +25 -14
- package/lib/commands/pull.ts +683 -420
- package/lib/commands/push.ts +1677 -2404
- package/lib/commands/run.ts +1 -1
- package/lib/commands/schema.ts +122 -0
- package/lib/commands/services/account.ts +200 -385
- package/lib/commands/services/console.ts +13 -34
- package/lib/commands/services/databases.ts +298 -1215
- package/lib/commands/services/functions.ts +115 -434
- package/lib/commands/services/graphql.ts +5 -2
- package/lib/commands/services/health.ts +87 -149
- package/lib/commands/services/locale.ts +36 -33
- package/lib/commands/services/messaging.ts +180 -999
- package/lib/commands/services/migrations.ts +54 -226
- package/lib/commands/services/project.ts +19 -23
- package/lib/commands/services/projects.ts +182 -714
- package/lib/commands/services/proxy.ts +30 -58
- package/lib/commands/services/sites.ts +107 -379
- package/lib/commands/services/storage.ts +93 -302
- package/lib/commands/services/tables-db.ts +1150 -0
- package/lib/commands/services/teams.ts +48 -110
- package/lib/commands/services/tokens.ts +16 -28
- package/lib/commands/services/users.ts +133 -403
- package/lib/commands/services/vcs.ts +48 -151
- package/lib/commands/types.ts +1 -1
- package/lib/commands/update.ts +13 -22
- package/lib/commands/utils/attributes.ts +719 -0
- package/lib/commands/utils/change-approval.ts +186 -0
- package/lib/commands/utils/database-sync.ts +180 -0
- package/lib/commands/utils/deployment.ts +184 -0
- package/lib/commands/utils/error-formatter.ts +417 -0
- package/lib/commands/utils/pools.ts +355 -0
- package/lib/config.ts +46 -82
- package/lib/constants.ts +22 -0
- package/lib/emulation/docker.ts +101 -87
- package/lib/parser.ts +16 -11
- package/lib/questions.ts +20 -21
- package/lib/sdks.ts +15 -11
- package/lib/types.ts +0 -229
- package/lib/utils.ts +45 -4
- package/package.json +12 -11
- package/scoop/appwrite.config.json +29 -19
- package/.github/workflows/build-verify.yml +0 -71
- package/bun.lock +0 -625
- package/dist/lib/commands/services/avatars.d.ts +0 -3
- package/dist/lib/commands/services/avatars.d.ts.map +0 -1
- package/dist/lib/commands/services/avatars.js +0 -118
- package/dist/lib/commands/services/avatars.js.map +0 -1
- package/dist/lib/commands/services/tablesdb.d.ts +0 -3
- package/dist/lib/commands/services/tablesdb.d.ts.map +0 -1
- package/dist/lib/commands/services/tablesdb.js.map +0 -1
- package/dist/scripts/generate-commands.d.ts +0 -2
- package/dist/scripts/generate-commands.d.ts.map +0 -1
- package/dist/scripts/generate-commands.js +0 -398
- package/dist/scripts/generate-commands.js.map +0 -1
- package/lib/commands/services/avatars.ts +0 -400
- package/lib/commands/services/tablesdb.ts +0 -1928
- package/scripts/generate-commands.ts +0 -539
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Command } from "commander";
|
|
2
2
|
import { sdkForProject } from "../../sdks.js";
|
|
3
|
-
import { actionRunner, commandDescriptions, parseBool, parseInteger, } from "../../parser.js";
|
|
3
|
+
import { actionRunner, commandDescriptions, parse, parseBool, parseInteger, } from "../../parser.js";
|
|
4
4
|
import { Databases, } from "@appwrite.io/console";
|
|
5
5
|
let databasesClient = null;
|
|
6
6
|
const getDatabasesClient = async () => {
|
|
@@ -17,85 +17,85 @@ export const databases = new Command("databases")
|
|
|
17
17
|
});
|
|
18
18
|
databases
|
|
19
19
|
.command(`list`)
|
|
20
|
-
.description(`
|
|
20
|
+
.description(`Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.`)
|
|
21
21
|
.option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name`)
|
|
22
22
|
.option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
|
|
23
23
|
.option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
|
|
24
|
-
.action(actionRunner(async ({ queries, search, total }) => await (await getDatabasesClient()).list(queries, search, total)));
|
|
24
|
+
.action(actionRunner(async ({ queries, search, total }) => parse(await (await getDatabasesClient()).list(queries, search, total))));
|
|
25
25
|
databases
|
|
26
26
|
.command(`create`)
|
|
27
|
-
.description(`
|
|
27
|
+
.description(`Create a new Database.
|
|
28
28
|
`)
|
|
29
29
|
.requiredOption(`--database-id <database-id>`, `Unique Id. Choose a custom ID or generate a random ID with \`ID.unique()\`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.`)
|
|
30
30
|
.requiredOption(`--name <name>`, `Database name. Max length: 128 chars.`)
|
|
31
31
|
.option(`--enabled [value]`, `Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.`, (value) => value === undefined ? true : parseBool(value))
|
|
32
|
-
.action(actionRunner(async ({ databaseId, name, enabled }) => await (await getDatabasesClient()).create(databaseId, name, enabled)));
|
|
32
|
+
.action(actionRunner(async ({ databaseId, name, enabled }) => parse(await (await getDatabasesClient()).create(databaseId, name, enabled))));
|
|
33
33
|
databases
|
|
34
34
|
.command(`list-transactions`)
|
|
35
35
|
.description(`List transactions across all databases.`)
|
|
36
36
|
.option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries).`)
|
|
37
|
-
.action(actionRunner(async ({ queries }) => await (await getDatabasesClient()).listTransactions(queries)));
|
|
37
|
+
.action(actionRunner(async ({ queries }) => parse(await (await getDatabasesClient()).listTransactions(queries))));
|
|
38
38
|
databases
|
|
39
39
|
.command(`create-transaction`)
|
|
40
40
|
.description(`Create a new transaction.`)
|
|
41
41
|
.option(`--ttl <ttl>`, `Seconds before the transaction expires.`, parseInteger)
|
|
42
|
-
.action(actionRunner(async ({ ttl }) => await (await getDatabasesClient()).createTransaction(ttl)));
|
|
42
|
+
.action(actionRunner(async ({ ttl }) => parse(await (await getDatabasesClient()).createTransaction(ttl))));
|
|
43
43
|
databases
|
|
44
44
|
.command(`get-transaction`)
|
|
45
45
|
.description(`Get a transaction by its unique ID.`)
|
|
46
46
|
.requiredOption(`--transaction-id <transaction-id>`, `Transaction ID.`)
|
|
47
|
-
.action(actionRunner(async ({ transactionId }) => await (await getDatabasesClient()).getTransaction(transactionId)));
|
|
47
|
+
.action(actionRunner(async ({ transactionId }) => parse(await (await getDatabasesClient()).getTransaction(transactionId))));
|
|
48
48
|
databases
|
|
49
49
|
.command(`update-transaction`)
|
|
50
50
|
.description(`Update a transaction, to either commit or roll back its operations.`)
|
|
51
51
|
.requiredOption(`--transaction-id <transaction-id>`, `Transaction ID.`)
|
|
52
52
|
.option(`--commit [value]`, `Commit transaction?`, (value) => value === undefined ? true : parseBool(value))
|
|
53
53
|
.option(`--rollback [value]`, `Rollback transaction?`, (value) => value === undefined ? true : parseBool(value))
|
|
54
|
-
.action(actionRunner(async ({ transactionId, commit, rollback }) => await (await getDatabasesClient()).updateTransaction(transactionId, commit, rollback)));
|
|
54
|
+
.action(actionRunner(async ({ transactionId, commit, rollback }) => parse(await (await getDatabasesClient()).updateTransaction(transactionId, commit, rollback))));
|
|
55
55
|
databases
|
|
56
56
|
.command(`delete-transaction`)
|
|
57
57
|
.description(`Delete a transaction by its unique ID.`)
|
|
58
58
|
.requiredOption(`--transaction-id <transaction-id>`, `Transaction ID.`)
|
|
59
|
-
.action(actionRunner(async ({ transactionId }) => await (await getDatabasesClient()).deleteTransaction(transactionId)));
|
|
59
|
+
.action(actionRunner(async ({ transactionId }) => parse(await (await getDatabasesClient()).deleteTransaction(transactionId))));
|
|
60
60
|
databases
|
|
61
61
|
.command(`create-operations`)
|
|
62
62
|
.description(`Create multiple operations in a single transaction.`)
|
|
63
63
|
.requiredOption(`--transaction-id <transaction-id>`, `Transaction ID.`)
|
|
64
64
|
.option(`--operations [operations...]`, `Array of staged operations.`)
|
|
65
|
-
.action(actionRunner(async ({ transactionId, operations }) => await (await getDatabasesClient()).createOperations(transactionId, operations)));
|
|
65
|
+
.action(actionRunner(async ({ transactionId, operations }) => parse(await (await getDatabasesClient()).createOperations(transactionId, operations))));
|
|
66
66
|
databases
|
|
67
67
|
.command(`list-usage`)
|
|
68
|
-
.description(`
|
|
68
|
+
.description(`List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.`)
|
|
69
69
|
.option(`--range <range>`, `Date range.`)
|
|
70
|
-
.action(actionRunner(async ({ range }) => await (await getDatabasesClient()).listUsage(range)));
|
|
70
|
+
.action(actionRunner(async ({ range }) => parse(await (await getDatabasesClient()).listUsage(range))));
|
|
71
71
|
databases
|
|
72
72
|
.command(`get`)
|
|
73
|
-
.description(`
|
|
73
|
+
.description(`Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.`)
|
|
74
74
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
75
|
-
.action(actionRunner(async ({ databaseId }) => await (await getDatabasesClient()).get(databaseId)));
|
|
75
|
+
.action(actionRunner(async ({ databaseId }) => parse(await (await getDatabasesClient()).get(databaseId))));
|
|
76
76
|
databases
|
|
77
77
|
.command(`update`)
|
|
78
|
-
.description(`
|
|
78
|
+
.description(`Update a database by its unique ID.`)
|
|
79
79
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
80
80
|
.requiredOption(`--name <name>`, `Database name. Max length: 128 chars.`)
|
|
81
81
|
.option(`--enabled [value]`, `Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.`, (value) => value === undefined ? true : parseBool(value))
|
|
82
|
-
.action(actionRunner(async ({ databaseId, name, enabled }) => await (await getDatabasesClient()).update(databaseId, name, enabled)));
|
|
82
|
+
.action(actionRunner(async ({ databaseId, name, enabled }) => parse(await (await getDatabasesClient()).update(databaseId, name, enabled))));
|
|
83
83
|
databases
|
|
84
84
|
.command(`delete`)
|
|
85
|
-
.description(`
|
|
85
|
+
.description(`Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.`)
|
|
86
86
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
87
|
-
.action(actionRunner(async ({ databaseId }) => await (await getDatabasesClient()).delete(databaseId)));
|
|
87
|
+
.action(actionRunner(async ({ databaseId }) => parse(await (await getDatabasesClient()).delete(databaseId))));
|
|
88
88
|
databases
|
|
89
89
|
.command(`list-collections`)
|
|
90
|
-
.description(`
|
|
90
|
+
.description(`Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.`)
|
|
91
91
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
92
92
|
.option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, documentSecurity`)
|
|
93
93
|
.option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
|
|
94
94
|
.option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
|
|
95
|
-
.action(actionRunner(async ({ databaseId, queries, search, total }) => await (await getDatabasesClient()).listCollections(databaseId, queries, search, total)));
|
|
95
|
+
.action(actionRunner(async ({ databaseId, queries, search, total }) => parse(await (await getDatabasesClient()).listCollections(databaseId, queries, search, total))));
|
|
96
96
|
databases
|
|
97
97
|
.command(`create-collection`)
|
|
98
|
-
.description(`
|
|
98
|
+
.description(`Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.`)
|
|
99
99
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
100
100
|
.requiredOption(`--collection-id <collection-id>`, `Unique Id. Choose a custom ID or generate a random ID with \`ID.unique()\`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.`)
|
|
101
101
|
.requiredOption(`--name <name>`, `Collection name. Max length: 128 chars.`)
|
|
@@ -104,127 +104,127 @@ databases
|
|
|
104
104
|
.option(`--enabled [value]`, `Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.`, (value) => value === undefined ? true : parseBool(value))
|
|
105
105
|
.option(`--attributes [attributes...]`, `Array of attribute definitions to create. Each attribute should contain: key (string), type (string: string, integer, float, boolean, datetime), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.`)
|
|
106
106
|
.option(`--indexes [indexes...]`, `Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of attribute keys), orders (array of ASC/DESC, optional), and lengths (array of integers, optional).`)
|
|
107
|
-
.action(actionRunner(async ({ databaseId, collectionId, name, permissions, documentSecurity, enabled, attributes, indexes
|
|
107
|
+
.action(actionRunner(async ({ databaseId, collectionId, name, permissions, documentSecurity, enabled, attributes, indexes }) => parse(await (await getDatabasesClient()).createCollection(databaseId, collectionId, name, permissions, documentSecurity, enabled, attributes, indexes))));
|
|
108
108
|
databases
|
|
109
109
|
.command(`get-collection`)
|
|
110
|
-
.description(`
|
|
110
|
+
.description(`Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.`)
|
|
111
111
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
112
112
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
113
|
-
.action(actionRunner(async ({ databaseId, collectionId }) => await (await getDatabasesClient()).getCollection(databaseId, collectionId)));
|
|
113
|
+
.action(actionRunner(async ({ databaseId, collectionId }) => parse(await (await getDatabasesClient()).getCollection(databaseId, collectionId))));
|
|
114
114
|
databases
|
|
115
115
|
.command(`update-collection`)
|
|
116
|
-
.description(`
|
|
116
|
+
.description(`Update a collection by its unique ID.`)
|
|
117
117
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
118
118
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
119
119
|
.requiredOption(`--name <name>`, `Collection name. Max length: 128 chars.`)
|
|
120
120
|
.option(`--permissions [permissions...]`, `An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).`)
|
|
121
121
|
.option(`--document-security [value]`, `Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https://appwrite.io/docs/permissions).`, (value) => value === undefined ? true : parseBool(value))
|
|
122
122
|
.option(`--enabled [value]`, `Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.`, (value) => value === undefined ? true : parseBool(value))
|
|
123
|
-
.action(actionRunner(async ({ databaseId, collectionId, name, permissions, documentSecurity, enabled
|
|
123
|
+
.action(actionRunner(async ({ databaseId, collectionId, name, permissions, documentSecurity, enabled }) => parse(await (await getDatabasesClient()).updateCollection(databaseId, collectionId, name, permissions, documentSecurity, enabled))));
|
|
124
124
|
databases
|
|
125
125
|
.command(`delete-collection`)
|
|
126
|
-
.description(`
|
|
126
|
+
.description(`Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.`)
|
|
127
127
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
128
128
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
129
|
-
.action(actionRunner(async ({ databaseId, collectionId }) => await (await getDatabasesClient()).deleteCollection(databaseId, collectionId)));
|
|
129
|
+
.action(actionRunner(async ({ databaseId, collectionId }) => parse(await (await getDatabasesClient()).deleteCollection(databaseId, collectionId))));
|
|
130
130
|
databases
|
|
131
131
|
.command(`list-attributes`)
|
|
132
|
-
.description(`
|
|
132
|
+
.description(`List attributes in the collection.`)
|
|
133
133
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
134
134
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
135
135
|
.option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, type, size, required, array, status, error`)
|
|
136
136
|
.option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
|
|
137
|
-
.action(actionRunner(async ({ databaseId, collectionId, queries, total }) => await (await getDatabasesClient()).listAttributes(databaseId, collectionId, queries, total)));
|
|
137
|
+
.action(actionRunner(async ({ databaseId, collectionId, queries, total }) => parse(await (await getDatabasesClient()).listAttributes(databaseId, collectionId, queries, total))));
|
|
138
138
|
databases
|
|
139
139
|
.command(`create-boolean-attribute`)
|
|
140
|
-
.description(`
|
|
140
|
+
.description(`Create a boolean attribute.
|
|
141
141
|
`)
|
|
142
142
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
143
143
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).`)
|
|
144
144
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
145
145
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
146
|
-
.option(`--
|
|
146
|
+
.option(`--xdefault [value]`, `Default value for attribute when not provided. Cannot be set when attribute is required.`, (value) => value === undefined ? true : parseBool(value))
|
|
147
147
|
.option(`--array [value]`, `Is attribute an array?`, (value) => value === undefined ? true : parseBool(value))
|
|
148
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, required,
|
|
148
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, required, xdefault, array }) => parse(await (await getDatabasesClient()).createBooleanAttribute(databaseId, collectionId, key, required, xdefault, array))));
|
|
149
149
|
databases
|
|
150
150
|
.command(`update-boolean-attribute`)
|
|
151
|
-
.description(`
|
|
151
|
+
.description(`Update a boolean attribute. Changing the \`default\` value will not update already existing documents.`)
|
|
152
152
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
153
153
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#createCollection).`)
|
|
154
154
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
155
155
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
156
|
-
.requiredOption(`--
|
|
156
|
+
.requiredOption(`--xdefault <xdefault>`, `Default value for attribute when not provided. Cannot be set when attribute is required.`, parseBool)
|
|
157
157
|
.option(`--new-key <new-key>`, `New attribute key.`)
|
|
158
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, required,
|
|
158
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, required, xdefault, newKey }) => parse(await (await getDatabasesClient()).updateBooleanAttribute(databaseId, collectionId, key, required, xdefault, newKey))));
|
|
159
159
|
databases
|
|
160
160
|
.command(`create-datetime-attribute`)
|
|
161
|
-
.description(`
|
|
161
|
+
.description(`Create a date time attribute according to the ISO 8601 standard.`)
|
|
162
162
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
163
163
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#createCollection).`)
|
|
164
164
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
165
165
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
166
|
-
.option(`--
|
|
166
|
+
.option(`--xdefault <xdefault>`, `Default value for the attribute in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.`)
|
|
167
167
|
.option(`--array [value]`, `Is attribute an array?`, (value) => value === undefined ? true : parseBool(value))
|
|
168
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, required,
|
|
168
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, required, xdefault, array }) => parse(await (await getDatabasesClient()).createDatetimeAttribute(databaseId, collectionId, key, required, xdefault, array))));
|
|
169
169
|
databases
|
|
170
170
|
.command(`update-datetime-attribute`)
|
|
171
|
-
.description(`
|
|
171
|
+
.description(`Update a date time attribute. Changing the \`default\` value will not update already existing documents.`)
|
|
172
172
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
173
173
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
174
174
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
175
175
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
176
|
-
.requiredOption(`--
|
|
176
|
+
.requiredOption(`--xdefault <xdefault>`, `Default value for attribute when not provided. Cannot be set when attribute is required.`)
|
|
177
177
|
.option(`--new-key <new-key>`, `New attribute key.`)
|
|
178
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, required,
|
|
178
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, required, xdefault, newKey }) => parse(await (await getDatabasesClient()).updateDatetimeAttribute(databaseId, collectionId, key, required, xdefault, newKey))));
|
|
179
179
|
databases
|
|
180
180
|
.command(`create-email-attribute`)
|
|
181
|
-
.description(`
|
|
181
|
+
.description(`Create an email attribute.
|
|
182
182
|
`)
|
|
183
183
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
184
184
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
185
185
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
186
186
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
187
|
-
.option(`--
|
|
187
|
+
.option(`--xdefault <xdefault>`, `Default value for attribute when not provided. Cannot be set when attribute is required.`)
|
|
188
188
|
.option(`--array [value]`, `Is attribute an array?`, (value) => value === undefined ? true : parseBool(value))
|
|
189
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, required,
|
|
189
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, required, xdefault, array }) => parse(await (await getDatabasesClient()).createEmailAttribute(databaseId, collectionId, key, required, xdefault, array))));
|
|
190
190
|
databases
|
|
191
191
|
.command(`update-email-attribute`)
|
|
192
|
-
.description(`
|
|
192
|
+
.description(`Update an email attribute. Changing the \`default\` value will not update already existing documents.
|
|
193
193
|
`)
|
|
194
194
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
195
195
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
196
196
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
197
197
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
198
|
-
.requiredOption(`--
|
|
198
|
+
.requiredOption(`--xdefault <xdefault>`, `Default value for attribute when not provided. Cannot be set when attribute is required.`)
|
|
199
199
|
.option(`--new-key <new-key>`, `New Attribute Key.`)
|
|
200
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, required,
|
|
200
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, required, xdefault, newKey }) => parse(await (await getDatabasesClient()).updateEmailAttribute(databaseId, collectionId, key, required, xdefault, newKey))));
|
|
201
201
|
databases
|
|
202
202
|
.command(`create-enum-attribute`)
|
|
203
|
-
.description(`
|
|
203
|
+
.description(`Create an enum attribute. The \`elements\` param acts as a white-list of accepted values for this attribute.
|
|
204
204
|
`)
|
|
205
205
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
206
206
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
207
207
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
208
208
|
.requiredOption(`--elements [elements...]`, `Array of enum values.`)
|
|
209
209
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
210
|
-
.option(`--
|
|
210
|
+
.option(`--xdefault <xdefault>`, `Default value for attribute when not provided. Cannot be set when attribute is required.`)
|
|
211
211
|
.option(`--array [value]`, `Is attribute an array?`, (value) => value === undefined ? true : parseBool(value))
|
|
212
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, elements, required,
|
|
212
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, elements, required, xdefault, array }) => parse(await (await getDatabasesClient()).createEnumAttribute(databaseId, collectionId, key, elements, required, xdefault, array))));
|
|
213
213
|
databases
|
|
214
214
|
.command(`update-enum-attribute`)
|
|
215
|
-
.description(`
|
|
215
|
+
.description(`Update an enum attribute. Changing the \`default\` value will not update already existing documents.
|
|
216
216
|
`)
|
|
217
217
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
218
218
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
219
219
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
220
220
|
.requiredOption(`--elements [elements...]`, `Updated list of enum values.`)
|
|
221
221
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
222
|
-
.requiredOption(`--
|
|
222
|
+
.requiredOption(`--xdefault <xdefault>`, `Default value for attribute when not provided. Cannot be set when attribute is required.`)
|
|
223
223
|
.option(`--new-key <new-key>`, `New Attribute Key.`)
|
|
224
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, elements, required,
|
|
224
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, elements, required, xdefault, newKey }) => parse(await (await getDatabasesClient()).updateEnumAttribute(databaseId, collectionId, key, elements, required, xdefault, newKey))));
|
|
225
225
|
databases
|
|
226
226
|
.command(`create-float-attribute`)
|
|
227
|
-
.description(`
|
|
227
|
+
.description(`Create a float attribute. Optionally, minimum and maximum values can be provided.
|
|
228
228
|
`)
|
|
229
229
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
230
230
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
@@ -232,25 +232,25 @@ databases
|
|
|
232
232
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
233
233
|
.option(`--min <min>`, `Minimum value.`, parseInteger)
|
|
234
234
|
.option(`--max <max>`, `Maximum value.`, parseInteger)
|
|
235
|
-
.option(`--
|
|
235
|
+
.option(`--xdefault <xdefault>`, `Default value. Cannot be set when required.`, parseInteger)
|
|
236
236
|
.option(`--array [value]`, `Is attribute an array?`, (value) => value === undefined ? true : parseBool(value))
|
|
237
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, required, min, max,
|
|
237
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, required, min, max, xdefault, array }) => parse(await (await getDatabasesClient()).createFloatAttribute(databaseId, collectionId, key, required, min, max, xdefault, array))));
|
|
238
238
|
databases
|
|
239
239
|
.command(`update-float-attribute`)
|
|
240
|
-
.description(`
|
|
240
|
+
.description(`Update a float attribute. Changing the \`default\` value will not update already existing documents.
|
|
241
241
|
`)
|
|
242
242
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
243
243
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
244
244
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
245
245
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
246
|
+
.requiredOption(`--xdefault <xdefault>`, `Default value. Cannot be set when required.`, parseInteger)
|
|
246
247
|
.option(`--min <min>`, `Minimum value.`, parseInteger)
|
|
247
248
|
.option(`--max <max>`, `Maximum value.`, parseInteger)
|
|
248
|
-
.requiredOption(`--default <default>`, `Default value. Cannot be set when required.`, parseInteger)
|
|
249
249
|
.option(`--new-key <new-key>`, `New Attribute Key.`)
|
|
250
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, required, min, max,
|
|
250
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, required, xdefault, min, max, newKey }) => parse(await (await getDatabasesClient()).updateFloatAttribute(databaseId, collectionId, key, required, xdefault, min, max, newKey))));
|
|
251
251
|
databases
|
|
252
252
|
.command(`create-integer-attribute`)
|
|
253
|
-
.description(`
|
|
253
|
+
.description(`Create an integer attribute. Optionally, minimum and maximum values can be provided.
|
|
254
254
|
`)
|
|
255
255
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
256
256
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
@@ -258,104 +258,104 @@ databases
|
|
|
258
258
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
259
259
|
.option(`--min <min>`, `Minimum value`, parseInteger)
|
|
260
260
|
.option(`--max <max>`, `Maximum value`, parseInteger)
|
|
261
|
-
.option(`--
|
|
261
|
+
.option(`--xdefault <xdefault>`, `Default value. Cannot be set when attribute is required.`, parseInteger)
|
|
262
262
|
.option(`--array [value]`, `Is attribute an array?`, (value) => value === undefined ? true : parseBool(value))
|
|
263
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, required, min, max,
|
|
263
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, required, min, max, xdefault, array }) => parse(await (await getDatabasesClient()).createIntegerAttribute(databaseId, collectionId, key, required, min, max, xdefault, array))));
|
|
264
264
|
databases
|
|
265
265
|
.command(`update-integer-attribute`)
|
|
266
|
-
.description(`
|
|
266
|
+
.description(`Update an integer attribute. Changing the \`default\` value will not update already existing documents.
|
|
267
267
|
`)
|
|
268
268
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
269
269
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
270
270
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
271
271
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
272
|
+
.requiredOption(`--xdefault <xdefault>`, `Default value. Cannot be set when attribute is required.`, parseInteger)
|
|
272
273
|
.option(`--min <min>`, `Minimum value`, parseInteger)
|
|
273
274
|
.option(`--max <max>`, `Maximum value`, parseInteger)
|
|
274
|
-
.requiredOption(`--default <default>`, `Default value. Cannot be set when attribute is required.`, parseInteger)
|
|
275
275
|
.option(`--new-key <new-key>`, `New Attribute Key.`)
|
|
276
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, required, min, max,
|
|
276
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, required, xdefault, min, max, newKey }) => parse(await (await getDatabasesClient()).updateIntegerAttribute(databaseId, collectionId, key, required, xdefault, min, max, newKey))));
|
|
277
277
|
databases
|
|
278
278
|
.command(`create-ip-attribute`)
|
|
279
|
-
.description(`
|
|
279
|
+
.description(`Create IP address attribute.
|
|
280
280
|
`)
|
|
281
281
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
282
282
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
283
283
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
284
284
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
285
|
-
.option(`--
|
|
285
|
+
.option(`--xdefault <xdefault>`, `Default value. Cannot be set when attribute is required.`)
|
|
286
286
|
.option(`--array [value]`, `Is attribute an array?`, (value) => value === undefined ? true : parseBool(value))
|
|
287
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, required,
|
|
287
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, required, xdefault, array }) => parse(await (await getDatabasesClient()).createIpAttribute(databaseId, collectionId, key, required, xdefault, array))));
|
|
288
288
|
databases
|
|
289
289
|
.command(`update-ip-attribute`)
|
|
290
|
-
.description(`
|
|
290
|
+
.description(`Update an ip attribute. Changing the \`default\` value will not update already existing documents.
|
|
291
291
|
`)
|
|
292
292
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
293
293
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
294
294
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
295
295
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
296
|
-
.requiredOption(`--
|
|
296
|
+
.requiredOption(`--xdefault <xdefault>`, `Default value. Cannot be set when attribute is required.`)
|
|
297
297
|
.option(`--new-key <new-key>`, `New Attribute Key.`)
|
|
298
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, required,
|
|
298
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, required, xdefault, newKey }) => parse(await (await getDatabasesClient()).updateIpAttribute(databaseId, collectionId, key, required, xdefault, newKey))));
|
|
299
299
|
databases
|
|
300
300
|
.command(`create-line-attribute`)
|
|
301
|
-
.description(`
|
|
301
|
+
.description(`Create a geometric line attribute.`)
|
|
302
302
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
303
303
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).`)
|
|
304
304
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
305
305
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
306
|
-
.option(`--
|
|
307
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, required,
|
|
306
|
+
.option(`--xdefault [xdefault...]`, `Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when attribute is required.`)
|
|
307
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, required, xdefault }) => parse(await (await getDatabasesClient()).createLineAttribute(databaseId, collectionId, key, required, xdefault))));
|
|
308
308
|
databases
|
|
309
309
|
.command(`update-line-attribute`)
|
|
310
|
-
.description(`
|
|
310
|
+
.description(`Update a line attribute. Changing the \`default\` value will not update already existing documents.`)
|
|
311
311
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
312
312
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#createCollection).`)
|
|
313
313
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
314
314
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
315
|
-
.option(`--
|
|
315
|
+
.option(`--xdefault [xdefault...]`, `Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when attribute is required.`)
|
|
316
316
|
.option(`--new-key <new-key>`, `New attribute key.`)
|
|
317
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, required,
|
|
317
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, required, xdefault, newKey }) => parse(await (await getDatabasesClient()).updateLineAttribute(databaseId, collectionId, key, required, xdefault, newKey))));
|
|
318
318
|
databases
|
|
319
319
|
.command(`create-point-attribute`)
|
|
320
|
-
.description(`
|
|
320
|
+
.description(`Create a geometric point attribute.`)
|
|
321
321
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
322
322
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).`)
|
|
323
323
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
324
324
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
325
|
-
.option(`--
|
|
326
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, required,
|
|
325
|
+
.option(`--xdefault [xdefault...]`, `Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.`)
|
|
326
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, required, xdefault }) => parse(await (await getDatabasesClient()).createPointAttribute(databaseId, collectionId, key, required, xdefault))));
|
|
327
327
|
databases
|
|
328
328
|
.command(`update-point-attribute`)
|
|
329
|
-
.description(`
|
|
329
|
+
.description(`Update a point attribute. Changing the \`default\` value will not update already existing documents.`)
|
|
330
330
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
331
331
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#createCollection).`)
|
|
332
332
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
333
333
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
334
|
-
.option(`--
|
|
334
|
+
.option(`--xdefault [xdefault...]`, `Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.`)
|
|
335
335
|
.option(`--new-key <new-key>`, `New attribute key.`)
|
|
336
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, required,
|
|
336
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, required, xdefault, newKey }) => parse(await (await getDatabasesClient()).updatePointAttribute(databaseId, collectionId, key, required, xdefault, newKey))));
|
|
337
337
|
databases
|
|
338
338
|
.command(`create-polygon-attribute`)
|
|
339
|
-
.description(`
|
|
339
|
+
.description(`Create a geometric polygon attribute.`)
|
|
340
340
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
341
341
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).`)
|
|
342
342
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
343
343
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
344
|
-
.option(`--
|
|
345
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, required,
|
|
344
|
+
.option(`--xdefault [xdefault...]`, `Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.`)
|
|
345
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, required, xdefault }) => parse(await (await getDatabasesClient()).createPolygonAttribute(databaseId, collectionId, key, required, xdefault))));
|
|
346
346
|
databases
|
|
347
347
|
.command(`update-polygon-attribute`)
|
|
348
|
-
.description(`
|
|
348
|
+
.description(`Update a polygon attribute. Changing the \`default\` value will not update already existing documents.`)
|
|
349
349
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
350
350
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#createCollection).`)
|
|
351
351
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
352
352
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
353
|
-
.option(`--
|
|
353
|
+
.option(`--xdefault [xdefault...]`, `Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.`)
|
|
354
354
|
.option(`--new-key <new-key>`, `New attribute key.`)
|
|
355
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, required,
|
|
355
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, required, xdefault, newKey }) => parse(await (await getDatabasesClient()).updatePolygonAttribute(databaseId, collectionId, key, required, xdefault, newKey))));
|
|
356
356
|
databases
|
|
357
357
|
.command(`create-relationship-attribute`)
|
|
358
|
-
.description(`
|
|
358
|
+
.description(`Create relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
|
|
359
359
|
`)
|
|
360
360
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
361
361
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
@@ -365,171 +365,179 @@ databases
|
|
|
365
365
|
.option(`--key <key>`, `Attribute Key.`)
|
|
366
366
|
.option(`--two-way-key <two-way-key>`, `Two Way Attribute Key.`)
|
|
367
367
|
.option(`--on-delete <on-delete>`, `Constraints option`)
|
|
368
|
-
.action(actionRunner(async ({ databaseId, collectionId, relatedCollectionId,
|
|
368
|
+
.action(actionRunner(async ({ databaseId, collectionId, relatedCollectionId, type, twoWay, key, twoWayKey, onDelete }) => parse(await (await getDatabasesClient()).createRelationshipAttribute(databaseId, collectionId, relatedCollectionId, type, twoWay, key, twoWayKey, onDelete))));
|
|
369
369
|
databases
|
|
370
370
|
.command(`create-string-attribute`)
|
|
371
|
-
.description(`
|
|
371
|
+
.description(`Create a string attribute.
|
|
372
372
|
`)
|
|
373
373
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
374
374
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).`)
|
|
375
375
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
376
376
|
.requiredOption(`--size <size>`, `Attribute size for text attributes, in number of characters.`, parseInteger)
|
|
377
377
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
378
|
-
.option(`--
|
|
378
|
+
.option(`--xdefault <xdefault>`, `Default value for attribute when not provided. Cannot be set when attribute is required.`)
|
|
379
379
|
.option(`--array [value]`, `Is attribute an array?`, (value) => value === undefined ? true : parseBool(value))
|
|
380
380
|
.option(`--encrypt [value]`, `Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.`, (value) => value === undefined ? true : parseBool(value))
|
|
381
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, size, required,
|
|
381
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, size, required, xdefault, array, encrypt }) => parse(await (await getDatabasesClient()).createStringAttribute(databaseId, collectionId, key, size, required, xdefault, array, encrypt))));
|
|
382
382
|
databases
|
|
383
383
|
.command(`update-string-attribute`)
|
|
384
|
-
.description(`
|
|
384
|
+
.description(`Update a string attribute. Changing the \`default\` value will not update already existing documents.
|
|
385
385
|
`)
|
|
386
386
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
387
387
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).`)
|
|
388
388
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
389
389
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
390
|
-
.requiredOption(`--
|
|
390
|
+
.requiredOption(`--xdefault <xdefault>`, `Default value for attribute when not provided. Cannot be set when attribute is required.`)
|
|
391
391
|
.option(`--size <size>`, `Maximum size of the string attribute.`, parseInteger)
|
|
392
392
|
.option(`--new-key <new-key>`, `New Attribute Key.`)
|
|
393
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, required,
|
|
393
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, required, xdefault, size, newKey }) => parse(await (await getDatabasesClient()).updateStringAttribute(databaseId, collectionId, key, required, xdefault, size, newKey))));
|
|
394
394
|
databases
|
|
395
395
|
.command(`create-url-attribute`)
|
|
396
|
-
.description(`
|
|
396
|
+
.description(`Create a URL attribute.
|
|
397
397
|
`)
|
|
398
398
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
399
399
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
400
400
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
401
401
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
402
|
-
.option(`--
|
|
402
|
+
.option(`--xdefault <xdefault>`, `Default value for attribute when not provided. Cannot be set when attribute is required.`)
|
|
403
403
|
.option(`--array [value]`, `Is attribute an array?`, (value) => value === undefined ? true : parseBool(value))
|
|
404
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, required,
|
|
404
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, required, xdefault, array }) => parse(await (await getDatabasesClient()).createUrlAttribute(databaseId, collectionId, key, required, xdefault, array))));
|
|
405
405
|
databases
|
|
406
406
|
.command(`update-url-attribute`)
|
|
407
|
-
.description(`
|
|
407
|
+
.description(`Update an url attribute. Changing the \`default\` value will not update already existing documents.
|
|
408
408
|
`)
|
|
409
409
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
410
410
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
411
411
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
412
412
|
.requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
|
|
413
|
-
.requiredOption(`--
|
|
413
|
+
.requiredOption(`--xdefault <xdefault>`, `Default value for attribute when not provided. Cannot be set when attribute is required.`)
|
|
414
414
|
.option(`--new-key <new-key>`, `New Attribute Key.`)
|
|
415
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, required,
|
|
415
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, required, xdefault, newKey }) => parse(await (await getDatabasesClient()).updateUrlAttribute(databaseId, collectionId, key, required, xdefault, newKey))));
|
|
416
416
|
databases
|
|
417
417
|
.command(`get-attribute`)
|
|
418
|
-
.description(`
|
|
418
|
+
.description(`Get attribute by ID.`)
|
|
419
419
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
420
420
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
421
421
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
422
|
-
.action(actionRunner(async ({ databaseId, collectionId, key }) => await (await getDatabasesClient()).getAttribute(databaseId, collectionId, key)));
|
|
422
|
+
.action(actionRunner(async ({ databaseId, collectionId, key }) => parse(await (await getDatabasesClient()).getAttribute(databaseId, collectionId, key))));
|
|
423
423
|
databases
|
|
424
424
|
.command(`delete-attribute`)
|
|
425
|
-
.description(`
|
|
425
|
+
.description(`Deletes an attribute.`)
|
|
426
426
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
427
427
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
428
428
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
429
|
-
.action(actionRunner(async ({ databaseId, collectionId, key }) => await (await getDatabasesClient()).deleteAttribute(databaseId, collectionId, key)));
|
|
429
|
+
.action(actionRunner(async ({ databaseId, collectionId, key }) => parse(await (await getDatabasesClient()).deleteAttribute(databaseId, collectionId, key))));
|
|
430
430
|
databases
|
|
431
431
|
.command(`update-relationship-attribute`)
|
|
432
|
-
.description(`
|
|
432
|
+
.description(`Update relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
|
|
433
433
|
`)
|
|
434
434
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
435
435
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
436
436
|
.requiredOption(`--key <key>`, `Attribute Key.`)
|
|
437
437
|
.option(`--on-delete <on-delete>`, `Constraints option`)
|
|
438
438
|
.option(`--new-key <new-key>`, `New Attribute Key.`)
|
|
439
|
-
.action(actionRunner(async ({ databaseId, collectionId, key, onDelete, newKey }) => await (await getDatabasesClient()).updateRelationshipAttribute(databaseId, collectionId, key, onDelete, newKey)));
|
|
439
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, onDelete, newKey }) => parse(await (await getDatabasesClient()).updateRelationshipAttribute(databaseId, collectionId, key, onDelete, newKey))));
|
|
440
440
|
databases
|
|
441
441
|
.command(`list-documents`)
|
|
442
|
-
.description(`
|
|
442
|
+
.description(`Get a list of all the user's documents in a given collection. You can use the query params to filter your results.`)
|
|
443
443
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
444
444
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).`)
|
|
445
445
|
.option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.`)
|
|
446
446
|
.option(`--transaction-id <transaction-id>`, `Transaction ID to read uncommitted changes within the transaction.`)
|
|
447
447
|
.option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
|
|
448
|
-
.action(actionRunner(async ({ databaseId, collectionId, queries, transactionId, total }) => await (await getDatabasesClient()).listDocuments(databaseId, collectionId, queries, transactionId, total)));
|
|
448
|
+
.action(actionRunner(async ({ databaseId, collectionId, queries, transactionId, total }) => parse(await (await getDatabasesClient()).listDocuments(databaseId, collectionId, queries, transactionId, total))));
|
|
449
449
|
databases
|
|
450
450
|
.command(`create-document`)
|
|
451
|
-
.description(`
|
|
451
|
+
.description(`Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.`)
|
|
452
452
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
453
453
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). Make sure to define attributes before creating documents.`)
|
|
454
454
|
.requiredOption(`--document-id <document-id>`, `Document ID. Choose a custom ID or generate a random ID with \`ID.unique()\`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.`)
|
|
455
455
|
.requiredOption(`--data <data>`, `Document data as JSON object.`)
|
|
456
456
|
.option(`--permissions [permissions...]`, `An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).`)
|
|
457
457
|
.option(`--transaction-id <transaction-id>`, `Transaction ID for staging the operation.`)
|
|
458
|
-
.action(actionRunner(async ({ databaseId, collectionId, documentId, data, permissions, transactionId
|
|
458
|
+
.action(actionRunner(async ({ databaseId, collectionId, documentId, data, permissions, transactionId }) => parse(await (await getDatabasesClient()).createDocument(databaseId, collectionId, documentId, JSON.parse(data), permissions, transactionId))));
|
|
459
|
+
databases
|
|
460
|
+
.command(`create-documents`)
|
|
461
|
+
.description(`Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.`)
|
|
462
|
+
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
463
|
+
.requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). Make sure to define attributes before creating documents.`)
|
|
464
|
+
.requiredOption(`--documents [documents...]`, `Array of documents data as JSON objects.`)
|
|
465
|
+
.option(`--transaction-id <transaction-id>`, `Transaction ID for staging the operation.`)
|
|
466
|
+
.action(actionRunner(async ({ databaseId, collectionId, documents, transactionId }) => parse(await (await getDatabasesClient()).createDocuments(databaseId, collectionId, documents, transactionId))));
|
|
459
467
|
databases
|
|
460
468
|
.command(`upsert-documents`)
|
|
461
|
-
.description(`
|
|
469
|
+
.description(`Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
|
|
462
470
|
`)
|
|
463
471
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
464
472
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
465
473
|
.requiredOption(`--documents [documents...]`, `Array of document data as JSON objects. May contain partial documents.`)
|
|
466
474
|
.option(`--transaction-id <transaction-id>`, `Transaction ID for staging the operation.`)
|
|
467
|
-
.action(actionRunner(async ({ databaseId, collectionId, documents, transactionId }) => await (await getDatabasesClient()).upsertDocuments(databaseId, collectionId, documents, transactionId)));
|
|
475
|
+
.action(actionRunner(async ({ databaseId, collectionId, documents, transactionId }) => parse(await (await getDatabasesClient()).upsertDocuments(databaseId, collectionId, documents, transactionId))));
|
|
468
476
|
databases
|
|
469
477
|
.command(`update-documents`)
|
|
470
|
-
.description(`
|
|
478
|
+
.description(`Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.`)
|
|
471
479
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
472
480
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
473
481
|
.option(`--data <data>`, `Document data as JSON object. Include only attribute and value pairs to be updated.`)
|
|
474
482
|
.option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.`)
|
|
475
483
|
.option(`--transaction-id <transaction-id>`, `Transaction ID for staging the operation.`)
|
|
476
|
-
.action(actionRunner(async ({ databaseId, collectionId, data, queries, transactionId }) => await (await getDatabasesClient()).updateDocuments(databaseId, collectionId, JSON.parse(data), queries, transactionId)));
|
|
484
|
+
.action(actionRunner(async ({ databaseId, collectionId, data, queries, transactionId }) => parse(await (await getDatabasesClient()).updateDocuments(databaseId, collectionId, JSON.parse(data), queries, transactionId))));
|
|
477
485
|
databases
|
|
478
486
|
.command(`delete-documents`)
|
|
479
|
-
.description(`
|
|
487
|
+
.description(`Bulk delete documents using queries, if no queries are passed then all documents are deleted.`)
|
|
480
488
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
481
489
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).`)
|
|
482
490
|
.option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.`)
|
|
483
491
|
.option(`--transaction-id <transaction-id>`, `Transaction ID for staging the operation.`)
|
|
484
|
-
.action(actionRunner(async ({ databaseId, collectionId, queries, transactionId }) => await (await getDatabasesClient()).deleteDocuments(databaseId, collectionId, queries, transactionId)));
|
|
492
|
+
.action(actionRunner(async ({ databaseId, collectionId, queries, transactionId }) => parse(await (await getDatabasesClient()).deleteDocuments(databaseId, collectionId, queries, transactionId))));
|
|
485
493
|
databases
|
|
486
494
|
.command(`get-document`)
|
|
487
|
-
.description(`
|
|
495
|
+
.description(`Get a document by its unique ID. This endpoint response returns a JSON object with the document data.`)
|
|
488
496
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
489
497
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).`)
|
|
490
498
|
.requiredOption(`--document-id <document-id>`, `Document ID.`)
|
|
491
499
|
.option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.`)
|
|
492
500
|
.option(`--transaction-id <transaction-id>`, `Transaction ID to read uncommitted changes within the transaction.`)
|
|
493
|
-
.action(actionRunner(async ({ databaseId, collectionId, documentId, queries, transactionId
|
|
501
|
+
.action(actionRunner(async ({ databaseId, collectionId, documentId, queries, transactionId }) => parse(await (await getDatabasesClient()).getDocument(databaseId, collectionId, documentId, queries, transactionId))));
|
|
494
502
|
databases
|
|
495
503
|
.command(`upsert-document`)
|
|
496
|
-
.description(`
|
|
504
|
+
.description(`Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.`)
|
|
497
505
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
498
506
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
499
507
|
.requiredOption(`--document-id <document-id>`, `Document ID.`)
|
|
500
508
|
.option(`--data <data>`, `Document data as JSON object. Include all required attributes of the document to be created or updated.`)
|
|
501
509
|
.option(`--permissions [permissions...]`, `An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).`)
|
|
502
510
|
.option(`--transaction-id <transaction-id>`, `Transaction ID for staging the operation.`)
|
|
503
|
-
.action(actionRunner(async ({ databaseId, collectionId, documentId, data, permissions, transactionId
|
|
511
|
+
.action(actionRunner(async ({ databaseId, collectionId, documentId, data, permissions, transactionId }) => parse(await (await getDatabasesClient()).upsertDocument(databaseId, collectionId, documentId, JSON.parse(data), permissions, transactionId))));
|
|
504
512
|
databases
|
|
505
513
|
.command(`update-document`)
|
|
506
|
-
.description(`
|
|
514
|
+
.description(`Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.`)
|
|
507
515
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
508
516
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
509
517
|
.requiredOption(`--document-id <document-id>`, `Document ID.`)
|
|
510
518
|
.option(`--data <data>`, `Document data as JSON object. Include only attribute and value pairs to be updated.`)
|
|
511
519
|
.option(`--permissions [permissions...]`, `An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).`)
|
|
512
520
|
.option(`--transaction-id <transaction-id>`, `Transaction ID for staging the operation.`)
|
|
513
|
-
.action(actionRunner(async ({ databaseId, collectionId, documentId, data, permissions, transactionId
|
|
521
|
+
.action(actionRunner(async ({ databaseId, collectionId, documentId, data, permissions, transactionId }) => parse(await (await getDatabasesClient()).updateDocument(databaseId, collectionId, documentId, JSON.parse(data), permissions, transactionId))));
|
|
514
522
|
databases
|
|
515
523
|
.command(`delete-document`)
|
|
516
|
-
.description(`
|
|
524
|
+
.description(`Delete a document by its unique ID.`)
|
|
517
525
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
518
526
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).`)
|
|
519
527
|
.requiredOption(`--document-id <document-id>`, `Document ID.`)
|
|
520
528
|
.option(`--transaction-id <transaction-id>`, `Transaction ID for staging the operation.`)
|
|
521
|
-
.action(actionRunner(async ({ databaseId, collectionId, documentId, transactionId }) => await (await getDatabasesClient()).deleteDocument(databaseId, collectionId, documentId, transactionId)));
|
|
529
|
+
.action(actionRunner(async ({ databaseId, collectionId, documentId, transactionId }) => parse(await (await getDatabasesClient()).deleteDocument(databaseId, collectionId, documentId, transactionId))));
|
|
522
530
|
databases
|
|
523
531
|
.command(`list-document-logs`)
|
|
524
|
-
.description(`
|
|
532
|
+
.description(`Get the document activity logs list by its unique ID.`)
|
|
525
533
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
526
534
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
527
535
|
.requiredOption(`--document-id <document-id>`, `Document ID.`)
|
|
528
536
|
.option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset`)
|
|
529
|
-
.action(actionRunner(async ({ databaseId, collectionId, documentId, queries }) => await (await getDatabasesClient()).listDocumentLogs(databaseId, collectionId, documentId, queries)));
|
|
537
|
+
.action(actionRunner(async ({ databaseId, collectionId, documentId, queries }) => parse(await (await getDatabasesClient()).listDocumentLogs(databaseId, collectionId, documentId, queries))));
|
|
530
538
|
databases
|
|
531
539
|
.command(`decrement-document-attribute`)
|
|
532
|
-
.description(`
|
|
540
|
+
.description(`Decrement a specific attribute of a document by a given value.`)
|
|
533
541
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
534
542
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
535
543
|
.requiredOption(`--document-id <document-id>`, `Document ID.`)
|
|
@@ -537,10 +545,10 @@ databases
|
|
|
537
545
|
.option(`--value <value>`, `Value to increment the attribute by. The value must be a number.`, parseInteger)
|
|
538
546
|
.option(`--min <min>`, `Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.`, parseInteger)
|
|
539
547
|
.option(`--transaction-id <transaction-id>`, `Transaction ID for staging the operation.`)
|
|
540
|
-
.action(actionRunner(async ({ databaseId, collectionId, documentId, attribute, value, min, transactionId
|
|
548
|
+
.action(actionRunner(async ({ databaseId, collectionId, documentId, attribute, value, min, transactionId }) => parse(await (await getDatabasesClient()).decrementDocumentAttribute(databaseId, collectionId, documentId, attribute, value, min, transactionId))));
|
|
541
549
|
databases
|
|
542
550
|
.command(`increment-document-attribute`)
|
|
543
|
-
.description(`
|
|
551
|
+
.description(`Increment a specific attribute of a document by a given value.`)
|
|
544
552
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
545
553
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
546
554
|
.requiredOption(`--document-id <document-id>`, `Document ID.`)
|
|
@@ -548,18 +556,18 @@ databases
|
|
|
548
556
|
.option(`--value <value>`, `Value to increment the attribute by. The value must be a number.`, parseInteger)
|
|
549
557
|
.option(`--max <max>`, `Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.`, parseInteger)
|
|
550
558
|
.option(`--transaction-id <transaction-id>`, `Transaction ID for staging the operation.`)
|
|
551
|
-
.action(actionRunner(async ({ databaseId, collectionId, documentId, attribute, value, max, transactionId
|
|
559
|
+
.action(actionRunner(async ({ databaseId, collectionId, documentId, attribute, value, max, transactionId }) => parse(await (await getDatabasesClient()).incrementDocumentAttribute(databaseId, collectionId, documentId, attribute, value, max, transactionId))));
|
|
552
560
|
databases
|
|
553
561
|
.command(`list-indexes`)
|
|
554
|
-
.description(`
|
|
562
|
+
.description(`List indexes in the collection.`)
|
|
555
563
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
556
564
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).`)
|
|
557
565
|
.option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, type, status, attributes, error`)
|
|
558
566
|
.option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
|
|
559
|
-
.action(actionRunner(async ({ databaseId, collectionId, queries, total }) => await (await getDatabasesClient()).listIndexes(databaseId, collectionId, queries, total)));
|
|
567
|
+
.action(actionRunner(async ({ databaseId, collectionId, queries, total }) => parse(await (await getDatabasesClient()).listIndexes(databaseId, collectionId, queries, total))));
|
|
560
568
|
databases
|
|
561
569
|
.command(`create-index`)
|
|
562
|
-
.description(`
|
|
570
|
+
.description(`Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.
|
|
563
571
|
Attributes can be \`key\`, \`fulltext\`, and \`unique\`.`)
|
|
564
572
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
565
573
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).`)
|
|
@@ -568,45 +576,45 @@ Attributes can be \`key\`, \`fulltext\`, and \`unique\`.`)
|
|
|
568
576
|
.requiredOption(`--attributes [attributes...]`, `Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.`)
|
|
569
577
|
.option(`--orders [orders...]`, `Array of index orders. Maximum of 100 orders are allowed.`)
|
|
570
578
|
.option(`--lengths [lengths...]`, `Length of index. Maximum of 100`)
|
|
571
|
-
.action(actionRunner(async ({ databaseId, collectionId, key,
|
|
579
|
+
.action(actionRunner(async ({ databaseId, collectionId, key, type, attributes, orders, lengths }) => parse(await (await getDatabasesClient()).createIndex(databaseId, collectionId, key, type, attributes, orders, lengths))));
|
|
572
580
|
databases
|
|
573
581
|
.command(`get-index`)
|
|
574
|
-
.description(`
|
|
582
|
+
.description(`Get an index by its unique ID.`)
|
|
575
583
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
576
584
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).`)
|
|
577
585
|
.requiredOption(`--key <key>`, `Index Key.`)
|
|
578
|
-
.action(actionRunner(async ({ databaseId, collectionId, key }) => await (await getDatabasesClient()).getIndex(databaseId, collectionId, key)));
|
|
586
|
+
.action(actionRunner(async ({ databaseId, collectionId, key }) => parse(await (await getDatabasesClient()).getIndex(databaseId, collectionId, key))));
|
|
579
587
|
databases
|
|
580
588
|
.command(`delete-index`)
|
|
581
|
-
.description(`
|
|
589
|
+
.description(`Delete an index.`)
|
|
582
590
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
583
591
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).`)
|
|
584
592
|
.requiredOption(`--key <key>`, `Index Key.`)
|
|
585
|
-
.action(actionRunner(async ({ databaseId, collectionId, key }) => await (await getDatabasesClient()).deleteIndex(databaseId, collectionId, key)));
|
|
593
|
+
.action(actionRunner(async ({ databaseId, collectionId, key }) => parse(await (await getDatabasesClient()).deleteIndex(databaseId, collectionId, key))));
|
|
586
594
|
databases
|
|
587
595
|
.command(`list-collection-logs`)
|
|
588
|
-
.description(`
|
|
596
|
+
.description(`Get the collection activity logs list by its unique ID.`)
|
|
589
597
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
590
598
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
591
599
|
.option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset`)
|
|
592
|
-
.action(actionRunner(async ({ databaseId, collectionId, queries }) => await (await getDatabasesClient()).listCollectionLogs(databaseId, collectionId, queries)));
|
|
600
|
+
.action(actionRunner(async ({ databaseId, collectionId, queries }) => parse(await (await getDatabasesClient()).listCollectionLogs(databaseId, collectionId, queries))));
|
|
593
601
|
databases
|
|
594
602
|
.command(`get-collection-usage`)
|
|
595
|
-
.description(`
|
|
603
|
+
.description(`Get usage metrics and statistics for a collection. Returning the total number of documents. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.`)
|
|
596
604
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
597
|
-
.option(`--range <range>`, `Date range.`)
|
|
598
605
|
.requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
|
|
599
|
-
.
|
|
606
|
+
.option(`--range <range>`, `Date range.`)
|
|
607
|
+
.action(actionRunner(async ({ databaseId, collectionId, range }) => parse(await (await getDatabasesClient()).getCollectionUsage(databaseId, collectionId, range))));
|
|
600
608
|
databases
|
|
601
609
|
.command(`list-logs`)
|
|
602
|
-
.description(`
|
|
610
|
+
.description(`Get the database activity logs list by its unique ID.`)
|
|
603
611
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
604
612
|
.option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset`)
|
|
605
|
-
.action(actionRunner(async ({ databaseId, queries }) => await (await getDatabasesClient()).listLogs(databaseId, queries)));
|
|
613
|
+
.action(actionRunner(async ({ databaseId, queries }) => parse(await (await getDatabasesClient()).listLogs(databaseId, queries))));
|
|
606
614
|
databases
|
|
607
615
|
.command(`get-usage`)
|
|
608
|
-
.description(`
|
|
616
|
+
.description(`Get usage metrics and statistics for a database. You can view the total number of collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.`)
|
|
609
617
|
.requiredOption(`--database-id <database-id>`, `Database ID.`)
|
|
610
618
|
.option(`--range <range>`, `Date range.`)
|
|
611
|
-
.action(actionRunner(async ({ databaseId, range }) => await (await getDatabasesClient()).getUsage(databaseId, range)));
|
|
619
|
+
.action(actionRunner(async ({ databaseId, range }) => parse(await (await getDatabasesClient()).getUsage(databaseId, range))));
|
|
612
620
|
//# sourceMappingURL=databases.js.map
|