Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

AdminClient

class AdminClient {
constructor({ path, fetchOptions, auth, tenant, database }?: {
path?: string;
fetchOptions?: RequestInit;
auth?: AuthOptions;
tenant?: string;
database?: string;
});
private api;
private authProvider;
database: string;
tenant: string;
 
createDatabase({ name, tenantName }: {
name: string;
tenantName: string;
}): Promise<{
name: string;
}>;
createTenant({ name }: {
name: string;
}): Promise<Tenant>;
deleteDatabase({ name, tenantName }: {
name: string;
tenantName: string;
}): Promise<void>;
getDatabase({ name, tenantName }: {
name: string;
tenantName: string;
}): Promise<Database>;
getTenant({ name }: {
name: string;
}): Promise<Tenant>;
listDatabases({ limit, offset, tenantName }: {
limit?: number;
offset?: number;
tenantName: string;
}): Promise<Database[]>;
setDatabase({ database }: {
database?: string;
}): Promise<void>;
setTenant({ tenant, database }: {
tenant: string;
database?: string;
}): Promise<void>;
}

§Constructors

§
new AdminClient({ path, fetchOptions, auth, tenant, database }?: {
path?: string;
fetchOptions?: RequestInit;
auth?: AuthOptions;
tenant?: string;
database?: string;
})
[src]

Creates a new AdminClient instance.

@param params
  • The parameters for creating a new client
@example
const client = new AdminClient({
  path: "http://localhost:8000"
});

§Properties

§
authProvider
[src]
§
database: string
[src]
§
tenant: string
[src]

§Methods

§
createDatabase({ name, tenantName }: {
name: string;
tenantName: string;
}): Promise<{
name: string;
}>
[src]

Creates a new database with the specified properties.

@param params
  • The parameters for creating a new database.
@param params.name
  • The name of the database.
@param params.tenantName
  • The name of the tenant.
@return

A promise that resolves to the created database.

@example
await adminClient.createDatabase({
  name: "my_database",
  tenantName: "my_tenant",
});
§
createTenant({ name }: {
name: string;
}): Promise<Tenant>
[src]

Creates a new tenant with the specified properties.

@param params
  • The parameters for creating a new tenant.
@param params.name
  • The name of the tenant.
@return

A promise that resolves to the created tenant.

@example
await adminClient.createTenant({
  name: "my_tenant",
});
§
deleteDatabase({ name, tenantName }: {
name: string;
tenantName: string;
}): Promise<void>
[src]

Deletes a database.

@param params
  • The parameters for deleting a database.
@param params.name
  • The name of the database.
@param params.tenantName
  • The name of the tenant.
@return

A promise that returns nothing.

§
getDatabase({ name, tenantName }: {
name: string;
tenantName: string;
}): Promise<Database>
[src]

Gets a database with the specified properties.

@param params
  • The parameters for getting a database.
@param params.name
  • The name of the database.
@param params.tenantName
  • The name of the tenant.
@return

A promise that resolves to the database.

@example
await adminClient.getDatabase({
  name: "my_database",
  tenantName: "my_tenant",
});
§
getTenant({ name }: {
name: string;
}): Promise<Tenant>
[src]

Gets a tenant with the specified properties.

@param params
  • The parameters for getting a tenant.
@param params.name
  • The name of the tenant.
@return

A promise that resolves to the tenant.

@example
await adminClient.getTenant({
  name: "my_tenant",
});
§
listDatabases({ limit, offset, tenantName }: {
limit?: number;
offset?: number;
tenantName: string;
}): Promise<Database[]>
[src]

Lists database for a specific tenant.

@param params
  • The parameters for listing databases.
@return

A promise that resolves to a list of databases.

§
setDatabase({ database }: {
database?: string;
}): Promise<void>
[src]

Sets the database for the client.

@param params
  • The parameters for setting the database.
@param params.database
  • The name of the database.
@return

A promise that returns nothing

@example
await adminClient.setDatabase({
  database: "my_database",
});
§
setTenant({ tenant, database }: {
tenant: string;
database?: string;
}): Promise<void>
[src]

Sets the tenant and database for the client.

@param params
  • The parameters for setting tenant and database.
@param params.tenant
  • The name of the tenant.
@param params.database
  • The name of the database.
@return

A promise that returns nothing

@example
await adminClient.setTenant({
  tenant: "my_tenant",
  database: "my_database",
});