import { Client } from '../client'; import type { Models } from '../models'; import { DatabaseUsageRange } from '../enums/database-usage-range'; import { RelationshipType } from '../enums/relationship-type'; import { RelationMutate } from '../enums/relation-mutate'; import { IndexType } from '../enums/index-type'; export declare class Databases { client: Client; constructor(client: Client); /** * List databases * * Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results. * * @param {string[]} queries * @param {string} search * @throws {AppwriteException} * @returns {Promise} */ list(queries?: string[], search?: string): Promise; /** * Create database * * Create a new Database. * * @param {string} databaseId * @param {string} name * @param {boolean} enabled * @throws {AppwriteException} * @returns {Promise} */ create(databaseId: string, name: string, enabled?: boolean): Promise; /** * Get databases usage stats * * * @param {DatabaseUsageRange} range * @throws {AppwriteException} * @returns {Promise} */ getUsage(range?: DatabaseUsageRange): Promise; /** * Get database * * Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata. * * @param {string} databaseId * @throws {AppwriteException} * @returns {Promise} */ get(databaseId: string): Promise; /** * Update database * * Update a database by its unique ID. * * @param {string} databaseId * @param {string} name * @param {boolean} enabled * @throws {AppwriteException} * @returns {Promise} */ update(databaseId: string, name: string, enabled?: boolean): Promise; /** * Delete database * * Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database. * * @param {string} databaseId * @throws {AppwriteException} * @returns {Promise<{}>} */ delete(databaseId: string): Promise<{}>; /** * List collections * * Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results. * * @param {string} databaseId * @param {string[]} queries * @param {string} search * @throws {AppwriteException} * @returns {Promise} */ listCollections(databaseId: string, queries?: string[], search?: string): Promise; /** * Create collection * * Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console. * * @param {string} databaseId * @param {string} collectionId * @param {string} name * @param {string[]} permissions * @param {boolean} documentSecurity * @param {boolean} enabled * @throws {AppwriteException} * @returns {Promise} */ createCollection(databaseId: string, collectionId: string, name: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise; /** * Get collection * * Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata. * * @param {string} databaseId * @param {string} collectionId * @throws {AppwriteException} * @returns {Promise} */ getCollection(databaseId: string, collectionId: string): Promise; /** * Update collection * * Update a collection by its unique ID. * * @param {string} databaseId * @param {string} collectionId * @param {string} name * @param {string[]} permissions * @param {boolean} documentSecurity * @param {boolean} enabled * @throws {AppwriteException} * @returns {Promise} */ updateCollection(databaseId: string, collectionId: string, name: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise; /** * Delete collection * * Delete a collection by its unique ID. Only users with write permissions have access to delete this resource. * * @param {string} databaseId * @param {string} collectionId * @throws {AppwriteException} * @returns {Promise<{}>} */ deleteCollection(databaseId: string, collectionId: string): Promise<{}>; /** * List attributes * * List attributes in the collection. * * @param {string} databaseId * @param {string} collectionId * @param {string[]} queries * @throws {AppwriteException} * @returns {Promise} */ listAttributes(databaseId: string, collectionId: string, queries?: string[]): Promise; /** * Create boolean attribute * * Create a boolean attribute. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @param {boolean} required * @param {boolean} xdefault * @param {boolean} array * @throws {AppwriteException} * @returns {Promise} */ createBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean, array?: boolean): Promise; /** * Update boolean attribute * * Update a boolean attribute. Changing the `default` value will not update already existing documents. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @param {boolean} required * @param {boolean} xdefault * @throws {AppwriteException} * @returns {Promise} */ updateBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean): Promise; /** * Create datetime attribute * * Create a date time attribute according to the ISO 8601 standard. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @param {boolean} required * @param {string} xdefault * @param {boolean} array * @throws {AppwriteException} * @returns {Promise} */ createDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise; /** * Update dateTime attribute * * Update a date time attribute. Changing the `default` value will not update already existing documents. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @param {boolean} required * @param {string} xdefault * @throws {AppwriteException} * @returns {Promise} */ updateDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise; /** * Create email attribute * * Create an email attribute. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @param {boolean} required * @param {string} xdefault * @param {boolean} array * @throws {AppwriteException} * @returns {Promise} */ createEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise; /** * Update email attribute * * Update an email attribute. Changing the `default` value will not update already existing documents. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @param {boolean} required * @param {string} xdefault * @throws {AppwriteException} * @returns {Promise} */ updateEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise; /** * Create enum attribute * * Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @param {string[]} elements * @param {boolean} required * @param {string} xdefault * @param {boolean} array * @throws {AppwriteException} * @returns {Promise} */ createEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string, array?: boolean): Promise; /** * Update enum attribute * * Update an enum attribute. Changing the `default` value will not update already existing documents. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @param {string[]} elements * @param {boolean} required * @param {string} xdefault * @throws {AppwriteException} * @returns {Promise} */ updateEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string): Promise; /** * Create float attribute * * Create a float attribute. Optionally, minimum and maximum values can be provided. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @param {boolean} required * @param {number} min * @param {number} max * @param {number} xdefault * @param {boolean} array * @throws {AppwriteException} * @returns {Promise} */ createFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min?: number, max?: number, xdefault?: number, array?: boolean): Promise; /** * Update float attribute * * Update a float attribute. Changing the `default` value will not update already existing documents. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @param {boolean} required * @param {number} min * @param {number} max * @param {number} xdefault * @throws {AppwriteException} * @returns {Promise} */ updateFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number): Promise; /** * Create integer attribute * * Create an integer attribute. Optionally, minimum and maximum values can be provided. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @param {boolean} required * @param {number} min * @param {number} max * @param {number} xdefault * @param {boolean} array * @throws {AppwriteException} * @returns {Promise} */ createIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min?: number, max?: number, xdefault?: number, array?: boolean): Promise; /** * Update integer attribute * * Update an integer attribute. Changing the `default` value will not update already existing documents. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @param {boolean} required * @param {number} min * @param {number} max * @param {number} xdefault * @throws {AppwriteException} * @returns {Promise} */ updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number): Promise; /** * Create IP address attribute * * Create IP address attribute. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @param {boolean} required * @param {string} xdefault * @param {boolean} array * @throws {AppwriteException} * @returns {Promise} */ createIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise; /** * Update IP address attribute * * Update an ip attribute. Changing the `default` value will not update already existing documents. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @param {boolean} required * @param {string} xdefault * @throws {AppwriteException} * @returns {Promise} */ updateIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise; /** * Create relationship attribute * * Create relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). * * @param {string} databaseId * @param {string} collectionId * @param {string} relatedCollectionId * @param {RelationshipType} type * @param {boolean} twoWay * @param {string} key * @param {string} twoWayKey * @param {RelationMutate} onDelete * @throws {AppwriteException} * @returns {Promise} */ createRelationshipAttribute(databaseId: string, collectionId: string, relatedCollectionId: string, type: RelationshipType, twoWay?: boolean, key?: string, twoWayKey?: string, onDelete?: RelationMutate): Promise; /** * Create string attribute * * Create a string attribute. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @param {number} size * @param {boolean} required * @param {string} xdefault * @param {boolean} array * @param {boolean} encrypt * @throws {AppwriteException} * @returns {Promise} */ createStringAttribute(databaseId: string, collectionId: string, key: string, size: number, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise; /** * Update string attribute * * Update a string attribute. Changing the `default` value will not update already existing documents. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @param {boolean} required * @param {string} xdefault * @throws {AppwriteException} * @returns {Promise} */ updateStringAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise; /** * Create URL attribute * * Create a URL attribute. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @param {boolean} required * @param {string} xdefault * @param {boolean} array * @throws {AppwriteException} * @returns {Promise} */ createUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise; /** * Update URL attribute * * Update an url attribute. Changing the `default` value will not update already existing documents. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @param {boolean} required * @param {string} xdefault * @throws {AppwriteException} * @returns {Promise} */ updateUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise; /** * Get attribute * * Get attribute by ID. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @throws {AppwriteException} * @returns {Promise<{}>} */ getAttribute(databaseId: string, collectionId: string, key: string): Promise<{}>; /** * Delete attribute * * Deletes an attribute. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @throws {AppwriteException} * @returns {Promise<{}>} */ deleteAttribute(databaseId: string, collectionId: string, key: string): Promise<{}>; /** * Update relationship attribute * * Update relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @param {RelationMutate} onDelete * @throws {AppwriteException} * @returns {Promise} */ updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: RelationMutate): Promise; /** * List documents * * Get a list of all the user's documents in a given collection. You can use the query params to filter your results. * * @param {string} databaseId * @param {string} collectionId * @param {string[]} queries * @throws {AppwriteException} * @returns {Promise>} */ listDocuments(databaseId: string, collectionId: string, queries?: string[]): Promise>; /** * Create document * * Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console. * * @param {string} databaseId * @param {string} collectionId * @param {string} documentId * @param {Omit} data * @param {string[]} permissions * @throws {AppwriteException} * @returns {Promise} */ createDocument(databaseId: string, collectionId: string, documentId: string, data: Omit, permissions?: string[]): Promise; /** * Get document * * Get a document by its unique ID. This endpoint response returns a JSON object with the document data. * * @param {string} databaseId * @param {string} collectionId * @param {string} documentId * @param {string[]} queries * @throws {AppwriteException} * @returns {Promise} */ getDocument(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise; /** * Update document * * Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated. * * @param {string} databaseId * @param {string} collectionId * @param {string} documentId * @param {Partial>} data * @param {string[]} permissions * @throws {AppwriteException} * @returns {Promise} */ updateDocument(databaseId: string, collectionId: string, documentId: string, data?: Partial>, permissions?: string[]): Promise; /** * Delete document * * Delete a document by its unique ID. * * @param {string} databaseId * @param {string} collectionId * @param {string} documentId * @throws {AppwriteException} * @returns {Promise<{}>} */ deleteDocument(databaseId: string, collectionId: string, documentId: string): Promise<{}>; /** * List document logs * * Get the document activity logs list by its unique ID. * * @param {string} databaseId * @param {string} collectionId * @param {string} documentId * @param {string[]} queries * @throws {AppwriteException} * @returns {Promise} */ listDocumentLogs(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise; /** * List indexes * * List indexes in the collection. * * @param {string} databaseId * @param {string} collectionId * @param {string[]} queries * @throws {AppwriteException} * @returns {Promise} */ listIndexes(databaseId: string, collectionId: string, queries?: string[]): Promise; /** * Create index * * Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request. Attributes can be `key`, `fulltext`, and `unique`. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @param {IndexType} type * @param {string[]} attributes * @param {string[]} orders * @throws {AppwriteException} * @returns {Promise} */ createIndex(databaseId: string, collectionId: string, key: string, type: IndexType, attributes: string[], orders?: string[]): Promise; /** * Get index * * Get index by ID. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @throws {AppwriteException} * @returns {Promise} */ getIndex(databaseId: string, collectionId: string, key: string): Promise; /** * Delete index * * Delete an index. * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @throws {AppwriteException} * @returns {Promise<{}>} */ deleteIndex(databaseId: string, collectionId: string, key: string): Promise<{}>; /** * List collection logs * * Get the collection activity logs list by its unique ID. * * @param {string} databaseId * @param {string} collectionId * @param {string[]} queries * @throws {AppwriteException} * @returns {Promise} */ listCollectionLogs(databaseId: string, collectionId: string, queries?: string[]): Promise; /** * Get collection usage stats * * * @param {string} databaseId * @param {string} collectionId * @param {DatabaseUsageRange} range * @throws {AppwriteException} * @returns {Promise} */ getCollectionUsage(databaseId: string, collectionId: string, range?: DatabaseUsageRange): Promise; /** * List database logs * * Get the database activity logs list by its unique ID. * * @param {string} databaseId * @param {string[]} queries * @throws {AppwriteException} * @returns {Promise} */ listLogs(databaseId: string, queries?: string[]): Promise; /** * Get database usage stats * * * @param {string} databaseId * @param {DatabaseUsageRange} range * @throws {AppwriteException} * @returns {Promise} */ getDatabaseUsage(databaseId: string, range?: DatabaseUsageRange): Promise; }