FirebaseDatabase

import { FirebaseDatabase } from "https://googleapis.deno.dev/v1/firebasedatabase:v1beta.ts";

The Firebase Realtime Database API enables programmatic provisioning and management of Realtime Database instances.

class FirebaseDatabase {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsLocationsInstancesCreate(

parent: string,

req: DatabaseInstance,

opts?: ProjectsLocationsInstancesCreateOptions,

): Promise<DatabaseInstance>;

async projectsLocationsInstancesDelete(name: string): Promise<DatabaseInstance>;

async projectsLocationsInstancesDisable(name: string, req: DisableDatabaseInstanceRequest): Promise<DatabaseInstance>;

async projectsLocationsInstancesGet(name: string): Promise<DatabaseInstance>;

async projectsLocationsInstancesList(parent: string, opts?: ProjectsLocationsInstancesListOptions): Promise<ListDatabaseInstancesResponse>;

async projectsLocationsInstancesReenable(name: string, req: ReenableDatabaseInstanceRequest): Promise<DatabaseInstance>;

async projectsLocationsInstancesUndelete(name: string, req: UndeleteDatabaseInstanceRequest): Promise<DatabaseInstance>;

}

§Constructors

new FirebaseDatabase(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsLocationsInstancesCreate(parent: string, req: DatabaseInstance, opts?: ProjectsLocationsInstancesCreateOptions): Promise<DatabaseInstance>

[src]

Requests that a new DatabaseInstance be created. The state of a successfully created DatabaseInstance is ACTIVE. Only available for projects on the Blaze plan. Projects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Note that it might take a few minutes for billing enablement state to propagate to Firebase systems.

@param parent

Required. The parent project for which to create a database instance, in the form: projects/{project-number}/locations/{location-id}.

projectsLocationsInstancesDelete(name: string): Promise<DatabaseInstance>

[src]

Marks a DatabaseInstance to be deleted. The DatabaseInstance will be set to the DELETED state for 20 days, and will be purged within 30 days. The default database cannot be deleted. IDs for deleted database instances may never be recovered or re-used. The Database may only be deleted if it is already in a DISABLED state.

@param name

Required. The fully qualified resource name of the database instance, in the form: projects/{project-number}/locations/{location-id}/instances/{database-id}

projectsLocationsInstancesDisable(name: string, req: DisableDatabaseInstanceRequest): Promise<DatabaseInstance>

[src]

Disables a DatabaseInstance. The database can be re-enabled later using ReenableDatabaseInstance. When a database is disabled, all reads and writes are denied, including view access in the Firebase console.

@param name

Required. The fully qualified resource name of the database instance, in the form: projects/{project-number}/locations/{location-id}/instances/{database-id}

projectsLocationsInstancesGet(name: string): Promise<DatabaseInstance>

[src]

Gets the DatabaseInstance identified by the specified resource name.

@param name

Required. The fully qualified resource name of the database instance, in the form: projects/{project-number}/locations/{location-id}/instances/{database-id}. database-id is a globally unique identifier across all parent collections. For convenience, this method allows you to supply - as a wildcard character in place of specific collections under projects and locations. The resulting wildcarding form of the method is: projects/-/locations/-/instances/{database-id}.

projectsLocationsInstancesList(parent: string, opts?: ProjectsLocationsInstancesListOptions): Promise<ListDatabaseInstancesResponse>

[src]

Lists each DatabaseInstance associated with the specified parent project. The list items are returned in no particular order, but will be a consistent view of the database instances when additional requests are made with a pageToken. The resulting list contains instances in any STATE. The list results may be stale by a few seconds. Use GetDatabaseInstance for consistent reads.

@param parent

Required. The parent project for which to list database instances, in the form: projects/{project-number}/locations/{location-id} To list across all locations, use a parent in the form: projects/{project-number}/locations/-

projectsLocationsInstancesReenable(name: string, req: ReenableDatabaseInstanceRequest): Promise<DatabaseInstance>

[src]

Enables a DatabaseInstance. The database must have been disabled previously using DisableDatabaseInstance. The state of a successfully reenabled DatabaseInstance is ACTIVE.

@param name

Required. The fully qualified resource name of the database instance, in the form: projects/{project-number}/locations/{location-id}/instances/{database-id}

projectsLocationsInstancesUndelete(name: string, req: UndeleteDatabaseInstanceRequest): Promise<DatabaseInstance>

[src]

Restores a DatabaseInstance that was previously marked to be deleted. After the delete method is used, DatabaseInstances are set to the DELETED state for 20 days, and will be purged within 30 days. Databases in the DELETED state can be undeleted without losing any data. This method may only be used on a DatabaseInstance in the DELETED state. Purged DatabaseInstances may not be recovered.

@param name

Required. The fully qualified resource name of the database instance, in the form: projects/{project-number}/locations/{location-id}/instances/{database-id}