Web Developers : 8-Creating a New Document in an Appwrite Database Collection

Screenshot from the tutorial

Creating a New Document in an Appwrite Database Collection

In modern web development, managing data efficiently is crucial. Appwrite is an open-source backend-as-a-service (BaaS) platform designed to simplify app development. One of its powerful features is the ability to create and manage databases. In this tutorial, we will walk you through the process of creating a new document in an Appwrite database collection.

What is Appwrite?

Appwrite is a self-hosted backend server that provides developers with essential tools to build applications. It includes numerous features such as user authentication, file storage, and database management. The database service allows you to create collections and documents, enabling you to organize and retrieve data easily.

Prerequisites

Before we dive into creating a new document, ensure that you have the following:

• An Appwrite server set up and running. You can follow the official installation guide if you haven't done so.
• Access to the Appwrite console.
• Familiarity with basic web development concepts and JavaScript.

Step 1: Access the Appwrite Console

To start, log in to your Appwrite console:

1. Open your web browser and navigate to your Appwrite server's URL (e.g., http://localhost if you're running it locally).
2. Log in using your credentials.

Once logged in, you will be taken to the dashboard.

Step 2: Create a Database

If you haven't created a database yet, follow these steps:

1. In the Appwrite console, click on Databases in the left sidebar.
2. Click on Create Database.
3. Fill in the database name and choose the necessary permissions.
4. Click Create to finalize your database.

Step 3: Create a Collection

Now that you have a database, you need to create a collection where documents will be stored.

1. Select your newly created database from the list.
2. Click on Create Collection.
3. Provide a name for your collection and define its permissions.
4. Click Create to set up the collection.

Step 4: Add Attributes to Your Collection

To define what kind of data you want to store in your documents, you must add attributes to your collection:

1. After creating a collection, you will be redirected to the collection's settings page.
2. Click on Add Attribute and choose the type (e.g., String, Integer, Boolean).
3. Fill in the necessary fields for the attribute, such as name and required status.
4. Repeat this for each attribute you want to add.
5. Once done, click Save.

Step 5: Creating a New Document

With your collection set up and attributes defined, it’s time to create a new document. You can do this using the Appwrite SDK in your JavaScript application.

Step 5.1: Install the Appwrite SDK

If you haven’t installed the Appwrite SDK yet, you can do so using npm:

npm install appwrite

Step 5.2: Initialize the SDK

In your JavaScript file, initialize the Appwrite client:

import { Client, Databases } from 'appwrite';

const client = new Client();
client
    .setEndpoint('http://localhost/v1') // Your API Endpoint
    .setProject('YOUR_PROJECT_ID'); // Your project ID

const databases = new Databases(client);

Step 5.3: Create the Document

Now, let’s create a function to add a new document to your collection:

async function createDocument() {
    const collectionId = 'YOUR_COLLECTION_ID'; // Your collection ID
    const documentId = 'unique()'; // Use 'unique()' for auto-generated ID
    const data = {
        attribute1: 'value1',
        attribute2: 'value2'
    };

    try {
        const response = await databases.createDocument('YOUR_DATABASE_ID', collectionId, documentId, data);
        console.log('Document created successfully:', response);
    } catch (error) {
        console.error('Error creating document:', error);
    }
}

createDocument();

Explanation of the Code

• collectionId: Replace with the ID of your collection.
• documentId: Use unique() to let Appwrite generate a unique ID automatically; otherwise, you can specify a custom ID.
• data: This object should match the structure defined by your collection's attributes.

Step 6: Testing Your Code

To test the document creation function, simply run your JavaScript application. If everything is set up correctly, you should see a success message in your console, and the new document should appear in your Appwrite console under the designated collection.

Conclusion

Creating a new document in an Appwrite database collection is a straightforward process that can significantly streamline your data management. By following this tutorial, you've learned how to set up a database, create a collection, define attributes, and use the Appwrite SDK to add documents programmatically.

Feel free to explore additional features in Appwrite, such as querying documents, updating, and deleting them. Happy coding!

For more information, visit the Appwrite documentation.

Another view from the tutorial

---

Connect with SkillBakery Studios

Explore more tutorials, tools, and resources:

• skillbakery.com
• Facebook
• X (Twitter)
• YouTube Channel

Posted by SkillBakery Studios