import * as outputs from "../types/output"; export interface GetDatabasePostgresDataImport { dataSource: outputs.GetDatabasePostgresDataImportDataSource; /** * When the import finished */ finishedAt: string; /** * Errors encountered during the import check */ importCheckErrors: string; /** * When the import started */ startedAt: string; /** * State of the data import */ state: string; } export interface GetDatabasePostgresDataImportDataSource { /** * Database name of the data source */ database: string; /** * Hostname of the data source */ hostname: string; /** * Port of the data source */ port: number; } export interface GetDatabasePostgresRegionData { /** * True if the region is the default for new branch creation */ currentDefault: boolean; /** * Name of the region */ displayName: string; /** * Whether or not the region is currently active */ enabled: boolean; /** * The ID of the region */ id: string; /** * Location of the region */ location: string; /** * Provider for the region (ex. AWS) */ provider: string; /** * Public IP addresses for the region */ publicIpAddresses: string[]; /** * The slug of the region */ slug: string; } export interface GetDatabaseVitessDataImport { dataSource: outputs.GetDatabaseVitessDataImportDataSource; /** * When the import finished */ finishedAt: string; /** * Errors encountered during the import check */ importCheckErrors: string; /** * When the import started */ startedAt: string; /** * State of the data import */ state: string; } export interface GetDatabaseVitessDataImportDataSource { /** * Database name of the data source */ database: string; /** * Hostname of the data source */ hostname: string; /** * Port of the data source */ port: number; } export interface GetDatabaseVitessRegionData { /** * True if the region is the default for new branch creation */ currentDefault: boolean; /** * Name of the region */ displayName: string; /** * Whether or not the region is currently active */ enabled: boolean; /** * The ID of the region */ id: string; /** * Location of the region */ location: string; /** * Provider for the region (ex. AWS) */ provider: string; /** * Public IP addresses for the region */ publicIpAddresses: string[]; /** * The slug of the region */ slug: string; } export interface GetDatabasesData { /** * Whether seeding branches with data is enabled for all branches */ allowDataBranching: boolean; /** * If the database has reached its backup restored branch limit */ atBackupRestoreBranchesLimit: boolean; /** * If the database has reached its development branch limit */ atDevelopmentBranchUsageLimit: boolean; /** * Whether to automatically manage Rails migrations during deploy requests */ automaticMigrations: boolean; /** * The total number of database branches */ branchesCount: number; /** * The URL to retrieve this database's branches via the API */ branchesUrl: string; /** * When the database was created */ createdAt: string; dataImport: outputs.GetDatabasesDataDataImport; /** * The default branch for the database */ defaultBranch: string; /** * Number of read only regions in the default branch */ defaultBranchReadOnlyRegionsCount: number; /** * Number of shards in the default branch */ defaultBranchShardCount: number; /** * Number of tables in the default branch schema */ defaultBranchTableCount: number; /** * The total number of database development branches */ developmentBranchesCount: number; /** * Whether foreign key constraints are enabled */ foreignKeysEnabled: boolean; /** * The URL to see this database's branches in the web UI */ htmlUrl: string; /** * The ID of the database */ id: string; /** * True if query insights is enabled for the database */ insightsEnabled: boolean; /** * Whether raw SQL queries are collected */ insightsRawQueries: boolean; /** * The total number of ongoing issues within a database */ issuesCount: number; /** * The kind of database */ kind: string; /** * Framework used for applying migrations */ migrationFramework: string; /** * Table name to use for copying schema migration data */ migrationTableName: string; /** * If the database requires multiple admins for deletion */ multipleAdminsRequiredForDeletion: boolean; /** * Name of the database */ name: string; /** * The total number of schema recommendations */ openSchemaRecommendationsCount: number; /** * The database plan */ plan: string; /** * Whether web console is enabled for production branches */ productionBranchWebConsole: boolean; /** * The total number of database production branches */ productionBranchesCount: number; /** * If the database is ready to be used */ ready: boolean; region: outputs.GetDatabasesDataRegion; /** * Whether an approval is required to deploy schema changes to this database */ requireApprovalForDeploy: boolean; /** * True if a branch has a queued resize request */ resizeQueued: boolean; /** * True if a branch is currently resizing */ resizing: boolean; /** * Whether to restrict branch creation to one region */ restrictBranchRegion: boolean; /** * When the default branch schema was last changed. */ schemaLastUpdatedAt: string; /** * If the database is sharded */ sharded: boolean; /** * State of the database */ state: string; /** * When the database was last updated */ updatedAt: string; /** * The URL to the database API endpoint */ url: string; } export interface GetDatabasesDataDataImport { dataSource: outputs.GetDatabasesDataDataImportDataSource; /** * When the import finished */ finishedAt: string; /** * Errors encountered during the import check */ importCheckErrors: string; /** * When the import started */ startedAt: string; /** * State of the data import */ state: string; } export interface GetDatabasesDataDataImportDataSource { /** * Database name of the data source */ database: string; /** * Hostname of the data source */ hostname: string; /** * Port of the data source */ port: number; } export interface GetDatabasesDataRegion { /** * True if the region is the default for new branch creation */ currentDefault: boolean; /** * Name of the region */ displayName: string; /** * Whether or not the region is currently active */ enabled: boolean; /** * The ID of the region */ id: string; /** * Location of the region */ location: string; /** * Provider for the region (ex. AWS) */ provider: string; /** * Public IP addresses for the region */ publicIpAddresses: string[]; /** * The slug of the region */ slug: string; } export interface GetOrganizationsData { /** * The billing email of the organization */ billingEmail: string; /** * When the organization was created */ createdAt: string; /** * The number of databases in the organization */ databaseCount: number; /** * Features that can be enabled on the organization */ features: { [key: string]: string; }; /** * Whether or not the organization has a payment method on file */ hasCard: boolean; /** * Whether or not the organization has past due billing invoices */ hasPastDueInvoices: boolean; /** * The ID for the organization */ id: string; /** * Whether or not the IdP provider is be responsible for managing roles in PlanetScale */ idpManagedRoles: boolean; /** * The expected monthly budget for the organization */ invoiceBudgetAmount: string; /** * The keyspace shard limit for the organization */ keyspaceShardLimit: number; /** * Whether or not the organization has managed tenancy enabled */ managedTenancy: boolean; /** * The name of the organization */ name: string; /** * Whether or not the organization requires payment information */ paymentInfoRequired: boolean; /** * The billing plan of the organization */ plan: string; /** * Whether or not the organization has single tenancy enabled */ singleTenancy: boolean; /** * Whether or not SSO is enabled on the organization */ sso: boolean; /** * Whether or not the organization uses an SSO directory */ ssoDirectory: boolean; /** * The URL of the organization's SSO portal */ ssoPortalUrl: string; /** * When the organization was last updated */ updatedAt: string; /** * Whether or not the organization's billing information is valid */ validBillingInfo: boolean; } export interface GetPostgresBranchActor { /** * The ID of the actor */ id: string; } export interface GetPostgresBranchRegionData { /** * The ID of the region */ id: string; } export interface GetPostgresBranchRoleActorData { /** * The URL of the actor's avatar */ avatarUrl: string; /** * The name of the actor */ displayName: string; /** * The ID of the actor */ id: string; } export interface GetPostgresBranchRoleBranchData { /** * When the resource was deleted, if deleted */ deletedAt: string; /** * The ID for the resource */ id: string; /** * The name for the resource */ name: string; } export interface GetPostgresBranchRoleQuerySafetySettings { /** * Require WHERE clause on DELETE statements */ requireWhereOnDelete: string; /** * Require WHERE clause on UPDATE statements */ requireWhereOnUpdate: string; } export interface GetPostgresBranchRolesData { /** * The database connection string */ accessHostUrl: string; actor: outputs.GetPostgresBranchRolesDataActor; branch: outputs.GetPostgresBranchRolesDataBranch; /** * When the role was created */ createdAt: string; /** * The database name */ databaseName: string; /** * Whether the role is the default postgres user */ default: boolean; /** * When the role was deleted */ deletedAt: string; /** * When the role was disabled */ disabledAt: string; /** * Error message available when dropping the role fails */ dropFailed: string; /** * When the role was dropped */ droppedAt: string; /** * True if the credentials are expired */ expired: boolean; /** * When the role expires */ expiresAt: string; /** * The ID of the role */ id: string; /** * Database roles these credentials inherit */ inheritedRoles: string[]; /** * The name of the role */ name: string; /** * The plain text password, available only after create */ password: string; /** * The database connection string for private connections */ privateAccessHostUrl: string; /** * The service name to set up private connectivity */ privateConnectionServiceName: string; querySafetySettings: outputs.GetPostgresBranchRolesDataQuerySafetySettings; /** * Number of seconds before the credentials expire */ ttl: number; /** * When the role was updated */ updatedAt: string; /** * The database user name */ username: string; } export interface GetPostgresBranchRolesDataActor { /** * The URL of the actor's avatar */ avatarUrl: string; /** * The name of the actor */ displayName: string; /** * The ID of the actor */ id: string; } export interface GetPostgresBranchRolesDataBranch { /** * When the resource was created */ createdAt: string; /** * When the resource was deleted, if deleted */ deletedAt: string; /** * The ID for the resource */ id: string; /** * The name for the resource */ name: string; /** * When the resource was last updated */ updatedAt: string; } export interface GetPostgresBranchRolesDataQuerySafetySettings { /** * Require WHERE clause on DELETE statements */ requireWhereOnDelete: string; /** * Require WHERE clause on UPDATE statements */ requireWhereOnUpdate: string; } export interface GetVitessBranchActor { /** * The ID of the actor */ id: string; } export interface GetVitessBranchPasswordActor { /** * The URL of the actor's avatar */ avatarUrl: string; /** * The name of the actor */ displayName: string; /** * The ID of the actor */ id: string; } export interface GetVitessBranchPasswordDatabaseBranch { /** * The ID for the branch */ id: string; /** * The address of the MySQL provider for the branch */ mysqlEdgeAddress: string; /** * The name for the branch */ name: string; /** * True if private connectivity is enabled */ privateEdgeConnectivity: boolean; /** * Whether or not the branch is a production branch */ production: boolean; } export interface GetVitessBranchPasswordRegion { /** * True if the region is the default for new branch creation */ currentDefault: boolean; /** * Name of the region */ displayName: string; /** * Whether or not the region is currently active */ enabled: boolean; /** * The ID of the region */ id: string; /** * Location of the region */ location: string; /** * Provider for the region (ex. AWS) */ provider: string; /** * Public IP addresses for the region */ publicIpAddresses: string[]; /** * The slug of the region */ slug: string; } export interface GetVitessBranchPasswordsData { /** * The regional host URL */ accessHostRegionalUrl: string; /** * The read-only replica host URLs */ accessHostRegionalUrls: string[]; /** * The host URL for the password */ accessHostUrl: string; actor: outputs.GetVitessBranchPasswordsDataActor; /** * List of IP addresses or CIDR ranges that can use this password */ cidrs: string[]; /** * When the password was created */ createdAt: string; databaseBranch: outputs.GetVitessBranchPasswordsDataDatabaseBranch; /** * When the password was deleted */ deletedAt: string; /** * True if the credentials connect directly to a vtgate, bypassing load balancers */ directVtgate: boolean; /** * The list of hosts in each availability zone providing direct access to a vtgate */ directVtgateAddresses: string[]; /** * True if the credentials are expired */ expired: boolean; /** * When the password will expire */ expiresAt: string; /** * The ID for the password */ id: string; /** * When the password was last used to execute a query */ lastUsedAt: string; /** * The display name for the password */ name: string; /** * The plain text password, available only after create */ plainText: string; region: outputs.GetVitessBranchPasswordsDataRegion; /** * Whether or not the password can be renewed */ renewable: boolean; /** * Whether or not the password is for a read replica */ replica: boolean; /** * The role for the password */ role: string; /** * Time to live (in seconds) for the password. The password will be invalid when TTL has passed */ ttlSeconds: number; /** * The username for the password */ username: string; } export interface GetVitessBranchPasswordsDataActor { /** * The URL of the actor's avatar */ avatarUrl: string; /** * The name of the actor */ displayName: string; /** * The ID of the actor */ id: string; } export interface GetVitessBranchPasswordsDataDatabaseBranch { /** * The ID for the branch */ id: string; /** * The address of the MySQL provider for the branch */ mysqlEdgeAddress: string; /** * The name for the branch */ name: string; /** * True if private connectivity is enabled */ privateEdgeConnectivity: boolean; /** * Whether or not the branch is a production branch */ production: boolean; } export interface GetVitessBranchPasswordsDataRegion { /** * True if the region is the default for new branch creation */ currentDefault: boolean; /** * Name of the region */ displayName: string; /** * Whether or not the region is currently active */ enabled: boolean; /** * The ID of the region */ id: string; /** * Location of the region */ location: string; /** * Provider for the region (ex. AWS) */ provider: string; /** * Public IP addresses for the region */ publicIpAddresses: string[]; /** * The slug of the region */ slug: string; } export interface GetVitessBranchRegionData { /** * The ID of the region */ id: string; } export interface PostgresBranchActor { /** * The ID of the actor */ id: string; } export interface PostgresBranchRegionData { /** * The ID of the region */ id: string; } export interface PostgresBranchRoleActorData { /** * The URL of the actor's avatar */ avatarUrl: string; /** * The name of the actor */ displayName: string; /** * The ID of the actor */ id: string; } export interface PostgresBranchRoleBranchData { /** * When the resource was deleted, if deleted */ deletedAt: string; /** * The ID for the resource */ id: string; /** * The name for the resource */ name: string; } export interface PostgresBranchRoleQuerySafetySettings { /** * Require WHERE clause on DELETE statements */ requireWhereOnDelete: string; /** * Require WHERE clause on UPDATE statements */ requireWhereOnUpdate: string; } export interface VitessBranchActor { /** * The ID of the actor */ id: string; } export interface VitessBranchPasswordActor { /** * The URL of the actor's avatar */ avatarUrl: string; /** * The name of the actor */ displayName: string; /** * The ID of the actor */ id: string; } export interface VitessBranchPasswordDatabaseBranch { /** * The ID for the branch */ id: string; /** * The address of the MySQL provider for the branch */ mysqlEdgeAddress: string; /** * The name for the branch */ name: string; /** * True if private connectivity is enabled */ privateEdgeConnectivity: boolean; /** * Whether or not the branch is a production branch */ production: boolean; } export interface VitessBranchPasswordRegion { /** * True if the region is the default for new branch creation */ currentDefault: boolean; /** * Name of the region */ displayName: string; /** * Whether or not the region is currently active */ enabled: boolean; /** * The ID of the region */ id: string; /** * Location of the region */ location: string; /** * Provider for the region (ex. AWS) */ provider: string; /** * Public IP addresses for the region */ publicIpAddresses: string[]; /** * The slug of the region */ slug: string; } export interface VitessBranchRegionData { /** * The ID of the region */ id: string; }