Class AppwriteProjectDatabases

Appwrite database context.

Implements

Iterable<AppwriteProjectDatabase>

Index

Constructors

Accessors

databaseList databases project

Methods

[iterator] getDatabase init

Constructors

constructor

new AppwriteProjectDatabases(project: AppwriteProject): AppwriteProjectDatabases
Initializes a new instance of that class.
Parameters
- project: AppwriteProject
  The underlying project.
Returns AppwriteProjectDatabases
- Defined in databases/databases.ts:44

Accessors

databaseList

get databaseList(): readonly AppwriteProjectDatabase[]
Returns the list of databases.

Returns readonly AppwriteProjectDatabase[]
- Defined in databases/databases.ts:69

databases

get databases(): Databases
Gets the underlying Databases instance of Appwrite.

Returns Databases
- Defined in databases/databases.ts:76

project

get project(): AppwriteProject
Gets the underlying project.

Returns AppwriteProject
- Defined in databases/databases.ts:145

Methods

[iterator]

"[iterator]"(): Iterator<AppwriteProjectDatabase, any, any>
Returns Iterator<AppwriteProjectDatabase, any, any>
Inherit Doc
Implementation of Iterable.[iterator]
- Defined in databases/databases.ts:51

getDatabase

getDatabase(name: string): AppwriteProjectDatabase
Returns a database by name.
Parameters
- name: string
  The name of the database.
Returns AppwriteProjectDatabase
The database.

Throws
AssertionError No single colledatabasection found with that name.
- Defined in databases/databases.ts:89

init

init(): Promise<void>
Initializes this instance.

Returns Promise<void>
- Defined in databases/databases.ts:108