Class DatabaseAPI

constructor

• new DatabaseAPI(client): DatabaseAPI

• Parameters

  • client: Client

  Returns DatabaseAPI

Static ReadonlyLOCALITIES

assignDatabaseUser

• assignDatabaseUser(request): Promise<DatabaseUser>

• "Assign a database user to a database".

  Parameters

  • request: Readonly<DatabaseApiAssignDatabaseUserRequest>

    The request DatabaseApiAssignDatabaseUserRequest

  Returns Promise<DatabaseUser>

  A Promise of DatabaseUser

changeDatabaseUserPassword

• changeDatabaseUserPassword(request): Promise<DatabaseUser>

• "Change the password of a database user".

  Parameters

  • request: Readonly<DatabaseApiChangeDatabaseUserPasswordRequest>

    The request DatabaseApiChangeDatabaseUserPasswordRequest

  Returns Promise<DatabaseUser>

  A Promise of DatabaseUser

createDatabase

• createDatabase(request): Promise<Webhosting.v1.Database>

• "Create a new database within your hosting plan".

  Parameters

  • request: Readonly<DatabaseApiCreateDatabaseRequest>

    The request DatabaseApiCreateDatabaseRequest

  Returns Promise<Webhosting.v1.Database>

  A Promise of Database

createDatabaseUser

• createDatabaseUser(request): Promise<DatabaseUser>

• "Create a new database user".

  Parameters

  • request: Readonly<DatabaseApiCreateDatabaseUserRequest>

    The request DatabaseApiCreateDatabaseUserRequest

  Returns Promise<DatabaseUser>

  A Promise of DatabaseUser

deleteDatabase

• deleteDatabase(request): Promise<Webhosting.v1.Database>

• "Delete a database within your hosting plan".

  Parameters

  • request: Readonly<DatabaseApiDeleteDatabaseRequest>

    The request DatabaseApiDeleteDatabaseRequest

  Returns Promise<Webhosting.v1.Database>

  A Promise of Database

deleteDatabaseUser

• deleteDatabaseUser(request): Promise<DatabaseUser>

• "Delete a database user".

  Parameters

  • request: Readonly<DatabaseApiDeleteDatabaseUserRequest>

    The request DatabaseApiDeleteDatabaseUserRequest

  Returns Promise<DatabaseUser>

  A Promise of DatabaseUser

getDatabase

• getDatabase(request): Promise<Webhosting.v1.Database>

• "Get details of a database within your hosting plan".

  Parameters

  • request: Readonly<DatabaseApiGetDatabaseRequest>

    The request DatabaseApiGetDatabaseRequest

  Returns Promise<Webhosting.v1.Database>

  A Promise of Database

getDatabaseUser

• getDatabaseUser(request): Promise<DatabaseUser>

• "Get details of a database user".

  Parameters

  • request: Readonly<DatabaseApiGetDatabaseUserRequest>

    The request DatabaseApiGetDatabaseUserRequest

  Returns Promise<DatabaseUser>

  A Promise of DatabaseUser

listDatabaseUsers

• listDatabaseUsers(request): Promise<ListDatabaseUsersResponse> & {
      [asyncIterator]: (() => AsyncGenerator<DatabaseUser[], void, void>);
      all: (() => Promise<DatabaseUser[]>);
  }

• "List all database users".

  Parameters

  • request: Readonly<Webhosting.v1.DatabaseApiListDatabaseUsersRequest>

    The request DatabaseApiListDatabaseUsersRequest

  Returns Promise<ListDatabaseUsersResponse> & {
      [asyncIterator]: (() => AsyncGenerator<DatabaseUser[], void, void>);
      all: (() => Promise<DatabaseUser[]>);
  }

  A Promise of ListDatabaseUsersResponse

listDatabases

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

• "List all databases within your hosting plan".

  Parameters

  • request: Readonly<Webhosting.v1.DatabaseApiListDatabasesRequest>

    The request DatabaseApiListDatabasesRequest

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

  A Promise of ListDatabasesResponse

unassignDatabaseUser

• unassignDatabaseUser(request): Promise<DatabaseUser>

• "Unassign a database user from a database".

  Parameters

  • request: Readonly<DatabaseApiUnassignDatabaseUserRequest>

    The request DatabaseApiUnassignDatabaseUserRequest

  Returns Promise<DatabaseUser>

  A Promise of DatabaseUser