Before you begin creating a database on the Appwrite cloud, you must first obtain the following credentials from the Appwrite console:<\/p>\n\n\n\n
- \n
- Appwrite API key<\/strong><\/li>\n\n\n\n
- Appwrite Project ID<\/strong><\/li>\n\n\n\n
- Appwrite Cloud API Endpoint<\/strong><\/li>\n<\/ul>\n\n\n\n
<\/a>Step 1: Obtaining Project ID<\/h3>\n\n\n\n
- \n
- To gain access to the Appwrite console, create an account on the Appwrite cloud (https:\/\/cloud.appwrite.io\/<\/a>) or log in if you already have one.<\/li>\n\n\n\n
- Click the “Create project”<\/strong> button, give your project a name, and then save the “Project ID”<\/strong>.<\/li>\n<\/ul>\n\n\n\n
![\"Project](\"https:\/\/geekpython.in\/wp-content\/uploads\/2023\/08\/Account-creation-1.png\")
<\/figure>\n\n\n\n<\/a>Step 2: Obtaining API Key<\/h3>\n\n\n\n
- \n
- After you’ve created a new project, scroll down and click the “API Key”<\/strong> button.<\/li>\n\n\n\n
- Fill in the API name and select the expiration time, then click the “Next”<\/strong> button, then add the scope “Database”<\/strong>, and finally click the “Create”<\/strong> button.<\/li>\n<\/ul>\n\n\n\n
![\"API](\"https:\/\/geekpython.in\/wp-content\/uploads\/2023\/08\/API-Setup-1.png\")
<\/figure>\n\n\n\n- \n
- Scroll down the Appwrite console and click on “API Keys”<\/strong> under the “Integrations”<\/strong> section, followed by your newly created API name<\/strong>.<\/li>\n\n\n\n
- Copy the project’s API Key by clicking on the “API Key Secret”<\/strong> button.<\/li>\n<\/ul>\n\n\n\n
![\"API](\"https:\/\/geekpython.in\/wp-content\/uploads\/2023\/08\/API-Secret.png\")
<\/figure>\n\n\n\n<\/a>Installing Appwrite’s Python Package<\/h1>\n\n\n\n
Using Python to create a database on the Appwrite cloud requires a Python package called
appwrite<\/code>, which provides API access to interact with the Appwrite backend and perform various tasks.<\/p>\n\n\n\nOpen a terminal window and type the following command to install the Python package
appwrite<\/code> withpip<\/code>.<\/p>\n\n\n\npip install appwrite<\/pre><\/div>\n\n\n\n
<\/a>Creating a Database<\/h1>\n\n\n\n
Creating a database on the Appwrite cloud involves simple steps. With all the required credentials gathered, let’s create a database using Python.<\/p>\n\n\n\n
<\/a>Importing Required Modules<\/h3>\n\n\n\n
from appwrite.client import Client\nfrom appwrite.services.databases import Databases\nfrom appwrite.id import ID\nimport os\nfrom dotenv import load_dotenv<\/pre><\/div>\n\n\n\n
from appwrite.client import Client<\/code>: To interact with the Appwrite API, theClient<\/code> class is imported from theappwrite.client<\/code> module. TheClient<\/code> class will allow you to configure the API key, Project ID, and API endpoint for making Appwrite backend requests.<\/p>\n\n\n\nfrom appwrite.services.databases import Databases<\/code>: To work with Database on the Appwrite cloud, theDatabases<\/code> class is imported from theappwrite.services.databases<\/code> module.<\/p>\n\n\n\nfrom appwrite.id import ID<\/code>: To generate unique IDs that can be used within Appwrite, theID<\/code> class is imported from theappwrite.id<\/code> module.<\/p>\n\n\n\nimport os<\/code>: To interact with the operating system, theos<\/code> module is imported.<\/p>\n\n\n\nfrom dotenv import load_dotenv<\/code>: To load environment variables to the Python file. The library can be installed withpip install python-dotenv<\/code>, if it is not installed.<\/p>\n\n\n\n<\/a>Configuring the Appwrite Client for API Access<\/h3>\n\n\n\n
\"\"\" Configuring Appwrite Client \"\"\"\n# Instantiating Appwrite Client\nclient = Client()\n\n# To load environment variables\nload_dotenv()\n\n# Configuring Appwrite Client\n(client\n # Setting API Endpoint\n .set_endpoint('https:\/\/cloud.appwrite.io\/v1')\n # Setting Project ID\n .set_project(os.getenv('PROJECT_ID'))\n # Setting API Key\n .set_key(os.getenv('API_KEY'))\n )<\/pre><\/div>\n\n\n\nInstantiating Appwrite Client<\/strong>: The
Client<\/code> class instance is created and stored in theclient<\/code> variable.<\/p>\n\n\n\nThe environment variables (
PROJECT_ID<\/code> andAPI_KEY<\/code>) are loaded into the script using theload_dotenv()<\/code> function.<\/p>\n\n\n\nSetting API Endpoint<\/strong>: The Appwrite client’s
set_endpoint()<\/code> method is used to set the API endpoint to the URL'<\/code>https:\/\/cloud.appwrite.io\/v1<\/code><\/a>'<\/code>.<\/p>\n\n\n\nSetting Project ID<\/strong>: The Appwrite client’s
set_project()<\/code> method is used to set the Project ID of the project by retrieving it from the environment variable'PROJECT ID'<\/code> usingos.getenv('PROJECT ID')<\/code>.<\/p>\n\n\n\nSetting API Key<\/strong>: Similarly, the API key is set with the
set_key()<\/code> method, and it was retrieved from the environment variable'API_KEY'<\/code> withos.getenv('API_KEY')<\/code>.<\/p>\n\n\n\n<\/a>Creating a New Database<\/h3>\n\n\n\n
\"\"\" Creating Database \"\"\"\n# Initializing databases service\ndatabases = Databases(client)\n\n# To generate unique database ID\ndb_id = ID.unique()\n\n# Creating a new database\ncreate_db = databases.create(db_id, 'BooksDB')\nprint(\"Database Successfully Created.\")<\/pre><\/div>\n\n\n\n
The
Databases<\/code> instance is created withDatabases(client)<\/code> and saved in thedatabases<\/code> variable. This enables interaction with the Appwrite Database API and the execution of various database-related tasks.<\/p>\n\n\n\nThe
ID.unique()<\/code> method is used to generate a unique ID for the database, which is then stored in thedb_id<\/code> variable.<\/p>\n\n\n\nThe code then creates a database by calling the
databases.create()<\/code> method, which takes two parameters: the database ID in this case,db_id<\/code>, and the database name, which in this case is'BooksDB'<\/code>.<\/p>\n\n\n\nIf you run the file, the database will be created and will be visible on the Appwrite cloud.<\/p>\n\n\n\n
![\"Database](\"https:\/\/geekpython.in\/wp-content\/uploads\/2023\/08\/db_created.png\")
<\/figure>\n\n\n\nCreating a database is not sufficient, especially if you intend to connect it to a web app. It’s required for CRUD operations like adding new data, updating it, reading it, and even deleting it.<\/p>\n\n\n\n
To create a fully functional database for data storage, the following must be created:<\/p>\n\n\n\n
- \n
- Collections<\/strong><\/li>\n\n\n\n
- Attributes<\/strong><\/li>\n\n\n\n
- Documents<\/strong><\/li>\n<\/ul>\n\n\n\n
<\/a>Creating Collections<\/h1>\n\n\n\n
Collections in the Appwrite database are data storage containers similar to tables in traditional databases.<\/p>\n\n\n\n
You can create multiple collections in a single Appwrite database to store and manage data from various sources, which will aid in data management.<\/p>\n\n\n\n
\"\"\"Creating Collections\"\"\"\n# Database ID\ndatabase_id = create_db['$id']\n# For Generating Unique Collection ID\ncollection_id = ID.unique()\n\n# Creating a New Collection\nnew_collection = databases.create_collection(database_id=database_id,\n collection_id=collection_id,\n name='Books')\n\nprint('Collection Successfully Created.')<\/pre><\/div>\n\n\n\nThe database ID is retrieved using
create_db['$id']<\/code> and stored in thedatabase_id<\/code> variable.<\/p>\n\n\n\nThe
ID.unique()<\/code> method is used to generate a unique ID for the collection in the database and the resulting ID is stored in thecollection_id<\/code> variable.<\/p>\n\n\n\nTo create a new collection, the
databases.create_collection()<\/code> method is used. It accepts three required arguments:database_id<\/code>, which represents the ID of the database where the collection will be created,collection_id<\/code>, a unique ID to ensure no conflicts with existing collections, andname<\/code>, which specifies the name of the new collection, which is\"Books\"<\/code> in this case.<\/p>\n\n\n\n![\"Collection](\"https:\/\/geekpython.in\/wp-content\/uploads\/2023\/08\/collection_name.png\")
<\/figure>\n\n\n\n<\/a>Creating Attributes<\/h1>\n\n\n\n
Following the completion of collections, the next step is to create attributes. The attributes define the schema of the data. Attributes are of different types<\/a>, you can choose as per requirement.<\/p>\n\n\n\n
Attributes are similar to fields in a traditional database table, where data is stored under the respective field. This ensures a standardized structure of the documents in the Appwrite database.<\/p>\n\n\n\n
Since the database is for Book<\/strong> details, the schema will be as follows:<\/p>\n\n\n\n
- \n
id<\/code> –integer<\/code>: Used to store the book’s ID.<\/li>\n\n\n\nimage<\/code> –url<\/code>: Book image<\/li>\n\n\n\ntitle<\/code> –string<\/code>: The title of the book<\/li>\n\n\n\nauthor<\/code> –string<\/code>: The author of the book<\/li>\n\n\n\ngenre<\/code> –string<\/code>: The book’s genre<\/li>\n<\/ul>\n\n\n\nThe attributes will be generated based on the fields listed above.<\/p>\n\n\n\n
\"\"\"Creating Attributes\"\"\"\n# Collection ID of Book\nc_id = new_collection['$id']\n\n\"\"\" Creating integer attribute \"\"\"\n# ID Attribute\nbook_id = databases.create_integer_attribute(database_id=database_id,\n collection_id=c_id,\n key=\"id\",\n required=True)\n\n\"\"\" Creating url attribute \"\"\"\n# URL Attribute\nbook_url = databases.create_url_attribute(database_id=database_id,\n collection_id=c_id,\n key=\"image\",\n required=True)\n\n\"\"\" Creating string attribute \"\"\"\n# Title Attribute\nbook_title = databases.create_string_attribute(database_id=database_id,\n collection_id=c_id,\n key=\"title\",\n required=True,\n size=100)\n\n# Author Attribute\nbook_author = databases.create_string_attribute(database_id=database_id,\n collection_id=c_id,\n key=\"author\",\n required=True,\n size=50)\n\n# Genre Attribute\nbook_genre = databases.create_string_attribute(database_id=database_id,\n collection_id=c_id,\n key=\"genre\",\n required=True,\n size=50)\n\nprint(\"Attributes Successfully Created.\")<\/pre><\/div>\n\n\n\n
The
create_integer_attribute()<\/code> method is used to create the integer attribute “id”<\/strong> for the “Books”<\/strong> collection. This method is invoked with four mandatory arguments:database_id<\/code> (set todatabase_id<\/code>),collection_id<\/code> (set toc_id<\/code>),key<\/code> (set to\"id\"<\/code> as the attribute name), andrequired<\/code> (set toTrue<\/code> to indicate that the value of this attribute cannot be left empty).<\/p>\n\n\n\nThe
create_url_attribute()<\/code> method is used to create the URL attribute “image”<\/strong> for the “Books”<\/strong> collection. This method is also called with four mandatory arguments:database_id<\/code>,collection_id<\/code>,key<\/code> set to\"image\"<\/code>, andrequired<\/code> parameter set toTrue<\/code>.<\/p>\n\n\n\nFinally, the
create_string_attribute()<\/code> method is used to create three string attributes, namely “title”<\/strong>, “author”<\/strong>, and “genre”<\/strong> for the “Books”<\/strong> collection. This method requires five parameters:database_id<\/code>,collection_id<\/code>,key<\/code>,required<\/code>, andsize<\/code>, which is the maximum number of characters allowed for the attribute.<\/p>\n\n\n\n![\"Attributes](\"https:\/\/geekpython.in\/wp-content\/uploads\/2023\/08\/image-1.jpeg\")
<\/figure>\n\n\n\nNow that all processes have been completed and the database is ready, you can add data from the frontend and store it as documents within the database.<\/p>\n\n\n\n
<\/a>Adding Documents<\/h1>\n\n\n\n
Following the schema that was created in the previous section, data will be added programmatically within the collection called “Books”<\/strong> in the database called “BooksDB”<\/strong> in this section.<\/p>\n\n\n\n
\"\"\" Adding Documents \"\"\"\n# Unique Identifier for Document ID\ndocument_id = ID.unique()\n\n\"\"\" Function for Adding Documents(data) in the Database \"\"\"\ndef add_doc(document):\n try:\n doc = databases.create_document(\n database_id=database_id,\n collection_id=c_id,\n document_id=document_id,\n data=document\n )\n\n print(\"Id:\", doc['id'])\n print(\"Image:\", doc['image'])\n print(\"Title:\", doc['title'])\n print(\"Author:\", doc['author'])\n print(\"Genre:\", doc['genre'])\n print(\"-\" * 20)\n\n except Exception as e:\n print(e)<\/pre><\/div>\n\n\n\n
The code defines an
add_doc<\/code> function that takes a single argument nameddocument<\/code>. Within the function’stry<\/code> block, thedatabases.create_document()<\/code> method is invoked to generate a document, which is subsequently stored in thedoc<\/code> variable.<\/p>\n\n\n\nThis method requires four mandatory parameters:
database_id<\/code> (set asdatabase_id<\/code>),collection_id<\/code> (set asc_id<\/code>),document_id<\/code> (representing a unique ID for the document, specifically assigned asdocument_id<\/code>), anddata<\/code> (representing the document’s content formatted in a dictionary).<\/p>\n\n\n\nThe
doc<\/code> variable stores a dictionary returned by thedatabases.create_document()<\/code>. Utilizing thisdoc<\/code> variable, the code retrieves the id<\/strong>, image<\/strong>, title<\/strong>, author<\/strong>, and genre<\/strong> of the added document and prints them.<\/p>\n\n\n\nIf an exception arises during the
try<\/code> block’s execution, the code captures the error and displays an error message.<\/p>\n\n\n\n<\/a>Data<\/h3>\n\n\n\n
# Data To Be Added\nbook_1 = {\n \"id\": 1,\n \"image\": \"https:\/\/i.pinimg.com\/474x\/dc\/17\/2d\/dc172d6fa3f5461d94e6d384aded2cb4.jpg\",\n \"title\": \"The Great Gatsby\",\n \"author\": \"F. Scott Fitzgerald\",\n \"genre\": \"Fiction\"\n}\n\nbook_2 = {\n \"id\": 2,\n \"image\": \"https:\/\/i.pinimg.com\/originals\/0b\/bf\/b5\/0bbfb59b4d5592e2e7fac9930012ce6d.jpg\",\n \"title\": \"To Kill a Mockingbird\",\n \"author\": \"Harper Lee\",\n \"genre\": \"Fiction\"\n}\n\nbook_3 = {\n \"id\": 3,\n \"image\": \"https:\/\/i.pinimg.com\/736x\/66\/1d\/17\/661d179ab722e67eed274d24b8965b0d.jpg\",\n \"title\": \"Pride and Prejudice\",\n \"author\": \"Jane Austen\",\n \"genre\": \"Romance\"\n}\n\nbook_4 = {\n \"id\": 4,\n \"image\": \"https:\/\/i.pinimg.com\/originals\/68\/c5\/4c\/68c54c9599ba37d9ab98c0c51afe2298.png\",\n \"title\": \"Crime and Punishment\",\n \"author\": \"Fyodor Dostoevsky\",\n \"genre\": \"Psychological Fiction\"\n}\n\n# Calling function with the data to be added\nadd_doc(book_1)\nadd_doc(book_2)\nadd_doc(book_3)\nadd_doc(book_4)\nprint(\"Documents Successfully Added.\")<\/pre><\/div>\n\n\n\nWhen you run the whole code, the following output will be prompted and the database, collection, and attributes will be created and documents will then be added.<\/p>\n\n\n\n
Database Successfully Created.\nCollection Successfully Created.\nAttributes Successfully Created.\nId: 1\nImage: https:\/\/i.pinimg.com\/474x\/dc\/17\/2d\/dc172d6fa3f5461d94e6d384aded2cb4.jpg\nTitle: The Great Gatsby\nAuthor: F. Scott Fitzgerald\nGenre: Fiction\n--------------------\nId: 2\nImage: https:\/\/i.pinimg.com\/originals\/0b\/bf\/b5\/0bbfb59b4d5592e2e7fac9930012ce6d.jpg\nTitle: To Kill a Mockingbird\nAuthor: Harper Lee\nGenre: Fiction\n--------------------\nId: 3\nImage: https:\/\/i.pinimg.com\/736x\/66\/1d\/17\/661d179ab722e67eed274d24b8965b0d.jpg\nTitle: Pride and Prejudice\nAuthor: Jane Austen\nGenre: Romance\n--------------------\nId: 4\nImage: https:\/\/i.pinimg.com\/originals\/68\/c5\/4c\/68c54c9599ba37d9ab98c0c51afe2298.png\nTitle: Crime and Punishment\nAuthor: Fyodor Dostoevsky\nGenre: Psychological Fiction\n--------------------\nDocuments Successfully Added.<\/pre><\/div>\n\n\n\n
![\"Documents](\"https:\/\/geekpython.in\/wp-content\/uploads\/2023\/08\/image-2.jpeg\")
<\/figure>\n\n\n\n<\/a>Source Code<\/h1>\n\n\n\n
Access the full source code from the following GitHub repository, clone or download the code and run it in your favorite IDE.<\/p>\n\n\n\n
Python Script For Creating Appwrite Database<\/a><\/p>\n\n\n\n
<\/a>Conclusion<\/h1>\n\n\n\n
The tutorial walked you through the steps of setting up a new database in the Appwrite cloud. It also includes instructions for creating a new project, creating an API key for the project, and obtaining the project ID and API key from the Appwrite cloud.<\/p>\n\n\n\n
Following the creation of the database, the tutorial takes you through the steps of making it fully functional by adding collections and attributes. The documents (data) are then added programmatically.<\/p>\n\n\n\n
Let’s go over the steps in this tutorial for creating a new database:<\/p>\n\n\n\n
- \n
- Obtaining the necessary Appwrite cloud credentials<\/strong><\/li>\n\n\n\n
- Installing the Python package<\/strong>
appwrite<\/code><\/li>\n\n\n\n- Making a database<\/strong><\/li>\n\n\n\n
- Making a collection<\/strong><\/li>\n\n\n\n
- Installing the Python package<\/strong>
- Attributes<\/strong><\/li>\n\n\n\n
- Copy the project’s API Key by clicking on the “API Key Secret”<\/strong> button.<\/li>\n<\/ul>\n\n\n\n
- Fill in the API name and select the expiration time, then click the “Next”<\/strong> button, then add the scope “Database”<\/strong>, and finally click the “Create”<\/strong> button.<\/li>\n<\/ul>\n\n\n\n
- Click the “Create project”<\/strong> button, give your project a name, and then save the “Project ID”<\/strong>.<\/li>\n<\/ul>\n\n\n\n
- Appwrite Project ID<\/strong><\/li>\n\n\n\n