Class API

constructor

• new API(client): ServerlessSQLDB.v1alpha1.API

• Parameters

  • client: Client

  Returns ServerlessSQLDB.v1alpha1.API

Static ReadonlyLOCALITIES

createDatabase

• createDatabase(request): Promise<ServerlessSQLDB.v1alpha1.Database>

• Create a new Serverless SQL Database. You must provide the following parameters: organization_id, project_id, name, cpu_min, cpu_max. You can also provide from_backup_id to create a database from a backup.

  Parameters

  • request: Readonly<ServerlessSQLDB.v1alpha1.CreateDatabaseRequest>

    The request CreateDatabaseRequest

  Returns Promise<ServerlessSQLDB.v1alpha1.Database>

  A Promise of Database

deleteDatabase

• deleteDatabase(request): Promise<ServerlessSQLDB.v1alpha1.Database>

• Delete a database. Deletes a database. You must provide the database_id parameter. All data stored in the database will be permanently deleted.

  Parameters

  • request: Readonly<ServerlessSQLDB.v1alpha1.DeleteDatabaseRequest>

    The request DeleteDatabaseRequest

  Returns Promise<ServerlessSQLDB.v1alpha1.Database>

  A Promise of Database

exportDatabaseBackup

• exportDatabaseBackup(request): Promise<ServerlessSQLDB.v1alpha1.DatabaseBackup>

• Export a database backup. Export a database backup providing a download link once the export process is completed. You must provide the backup_id parameter.

  Parameters

  • request: Readonly<ServerlessSQLDB.v1alpha1.ExportDatabaseBackupRequest>

    The request ExportDatabaseBackupRequest

  Returns Promise<ServerlessSQLDB.v1alpha1.DatabaseBackup>

  A Promise of DatabaseBackup

getDatabase

• getDatabase(request): Promise<ServerlessSQLDB.v1alpha1.Database>

• Get a database information. Retrieve information about your Serverless SQL Database. You must provide the database_id parameter.

  Parameters

  • request: Readonly<GetDatabaseRequest>

    The request GetDatabaseRequest

  Returns Promise<ServerlessSQLDB.v1alpha1.Database>

  A Promise of Database

getDatabaseBackup

• getDatabaseBackup(request): Promise<ServerlessSQLDB.v1alpha1.DatabaseBackup>

• Get a database backup information. Retrieve information about your Serverless SQL Database backup. You must provide the backup_id parameter.

  Parameters

  • request: Readonly<ServerlessSQLDB.v1alpha1.GetDatabaseBackupRequest>

    The request GetDatabaseBackupRequest

  Returns Promise<ServerlessSQLDB.v1alpha1.DatabaseBackup>

  A Promise of DatabaseBackup

listDatabaseBackups

• listDatabaseBackups(request): Promise<ServerlessSQLDB.v1alpha1.ListDatabaseBackupsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<ServerlessSQLDB.v1alpha1.DatabaseBackup[], void, void>);
      all: (() => Promise<ServerlessSQLDB.v1alpha1.DatabaseBackup[]>);
  }

• List your Serverless SQL Database backups. List all Serverless SQL Database backups for a given Scaleway Project or Database. By default, the backups returned in the list are ordered by creation date in descending order, though this can be modified via the order_by field.

  Parameters

  • request: Readonly<ServerlessSQLDB.v1alpha1.ListDatabaseBackupsRequest>

    The request ListDatabaseBackupsRequest

  Returns Promise<ServerlessSQLDB.v1alpha1.ListDatabaseBackupsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<ServerlessSQLDB.v1alpha1.DatabaseBackup[], void, void>);
      all: (() => Promise<ServerlessSQLDB.v1alpha1.DatabaseBackup[]>);
  }

  A Promise of ListDatabaseBackupsResponse

listDatabases

• listDatabases(request?): Promise<ServerlessSQLDB.v1alpha1.ListDatabasesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<ServerlessSQLDB.v1alpha1.Database[], void, void>);
      all: (() => Promise<ServerlessSQLDB.v1alpha1.Database[]>);
  }

• List your Serverless SQL Databases. List all Serverless SQL Databases for a given Scaleway Organization or Scaleway Project. By default, the databases returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. For the name parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter.

  Parameters

  • request: Readonly<ServerlessSQLDB.v1alpha1.ListDatabasesRequest> = {}

    The request ListDatabasesRequest

  Returns Promise<ServerlessSQLDB.v1alpha1.ListDatabasesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<ServerlessSQLDB.v1alpha1.Database[], void, void>);
      all: (() => Promise<ServerlessSQLDB.v1alpha1.Database[]>);
  }

  A Promise of ListDatabasesResponse

restoreDatabaseFromBackup

• restoreDatabaseFromBackup(request): Promise<ServerlessSQLDB.v1alpha1.Database>

• Restore a database from a backup. Restore a database from a backup. You must provide the backup_id parameter.

  Parameters

  • request: Readonly<RestoreDatabaseFromBackupRequest>

    The request RestoreDatabaseFromBackupRequest

  Returns Promise<ServerlessSQLDB.v1alpha1.Database>

  A Promise of Database

updateDatabase

• updateDatabase(request): Promise<ServerlessSQLDB.v1alpha1.Database>

• Update database information. Update CPU limits of your Serverless SQL Database. You must provide the database_id parameter.

  Parameters

  • request: Readonly<ServerlessSQLDB.v1alpha1.UpdateDatabaseRequest>

    The request UpdateDatabaseRequest

  Returns Promise<ServerlessSQLDB.v1alpha1.Database>

  A Promise of Database

waitForDatabase

• waitForDatabase(request, options?): Promise<ServerlessSQLDB.v1alpha1.Database>

• Waits for Database to be in a final state.

  Parameters

  • request: Readonly<GetDatabaseRequest>

    The request GetDatabaseRequest
  • Optionaloptions: Readonly<WaitForOptions<ServerlessSQLDB.v1alpha1.Database>>

    The waiting options

  Returns Promise<ServerlessSQLDB.v1alpha1.Database>

  A Promise of Database