import { Service } from '../service'; import { Client } from '../client'; import type { Models } from '../models'; export declare class Databases extends Service { 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 * @throws {AppwriteException} * @returns {Promise} */ create(databaseId: string, name: string): Promise; /** * Get usage stats for the database * * * @param {string} range * @throws {AppwriteException} * @returns {Promise} */ getUsage(range?: string): 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 * @throws {AppwriteException} * @returns {Promise} */ update(databaseId: string, name: string): 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](/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 * @throws {AppwriteException} * @returns {Promise} */ createCollection(databaseId: string, collectionId: string, name: string, permissions?: string[], documentSecurity?: 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 * * * @param {string} databaseId * @param {string} collectionId * @throws {AppwriteException} * @returns {Promise} */ listAttributes(databaseId: string, collectionId: 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 * * * @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 * * * @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 * * * @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 * * * @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](/docs/databases-relationships#relationship-attributes). * * * @param {string} databaseId * @param {string} collectionId * @param {string} relatedCollectionId * @param {string} type * @param {boolean} twoWay * @param {string} key * @param {string} twoWayKey * @param {string} onDelete * @throws {AppwriteException} * @returns {Promise} */ createRelationshipAttribute(databaseId: string, collectionId: string, relatedCollectionId: string, type: string, twoWay?: boolean, key?: string, twoWayKey?: string, onDelete?: string): 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 * @throws {AppwriteException} * @returns {Promise} */ createStringAttribute(databaseId: string, collectionId: string, key: string, size: number, required: boolean, xdefault?: string, array?: 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 * * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @throws {AppwriteException} * @returns {Promise} */ getAttribute(databaseId: string, collectionId: string, key: string): Promise<{}>; /** * Delete 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](/docs/databases-relationships#relationship-attributes). * * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @param {string} onDelete * @throws {AppwriteException} * @returns {Promise} */ updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: string): 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](/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 * * * @param {string} databaseId * @param {string} collectionId * @throws {AppwriteException} * @returns {Promise} */ listIndexes(databaseId: string, collectionId: string): Promise; /** * Create Index * * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @param {string} type * @param {string[]} attributes * @param {string[]} orders * @throws {AppwriteException} * @returns {Promise} */ createIndex(databaseId: string, collectionId: string, key: string, type: string, attributes: string[], orders?: string[]): Promise; /** * Get Index * * * @param {string} databaseId * @param {string} collectionId * @param {string} key * @throws {AppwriteException} * @returns {Promise} */ getIndex(databaseId: string, collectionId: string, key: string): Promise; /** * Delete 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 usage stats for a collection * * * @param {string} databaseId * @param {string} collectionId * @param {string} range * @throws {AppwriteException} * @returns {Promise} */ getCollectionUsage(databaseId: string, collectionId: string, range?: string): 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 usage stats for the database * * * @param {string} databaseId * @param {string} range * @throws {AppwriteException} * @returns {Promise} */ getDatabaseUsage(databaseId: string, range?: string): Promise; }