Merge pull request #2133 from appwrite/add-csv-import-docs

Add csv import docs

Author: adityaoberai

STYLE.md

@@ -144,21 +144,21 @@ the tone and voice remains consistent.
 - All titles, headings, buttons, and labels should be written in **sentence case**. If you're not sure what sentence case should look like, check [APA's style guide](https://apastyle.apa.org/style-grammar-guidelines/capitalization/sentence-case) or check with ChatGPT and other LLMs which reliably converts titles to sentence case.
 - All headings in a docs page begin with `# Heading` then `## Heading` and `### Heading`. Internally, they're converted to H2 to H4 tags.
 - All headings should have an ID label, for example `# Cool heading {% #cool-heading %}` the `#cool-heading` ID will be used to generate the table of contents and add links to the heading.
-- Prefer verbs over gerunds, for example, say "Create documents" not "Creating documents".
+- Prefer verbs to gerunds, for example, say "Create documents" not "Creating documents".
 
 ### Extended Markdoc components
 
-Appwrite's documentation uses extended markdown syntax. You can find all of the available partials types in the [CONTENT.md file](./CONTENT.md).
+Appwrite's documentation uses extended Markdown syntax. You can find all the available partials types in the [CONTENT.md file](./CONTENT.md).
 
 ### Screenshots
 
 - When contributing upload original screenshots. The Appwrite design team will edit the screenshot to be consistent with other screenshots in the docs.
 - Screenshots must be 16:9
-- Screnshots should be taken in a 1400 x 900 view port on 3x DPR in browser developer tools.
+- Screenshots should be taken in a 1400 x 900 view port on 3x DPR in browser developer tools.
 - Use generic and sensible organization, project, and resource names. Avoid names like `test`, `demo`, or `sdlkfj`.
-- All screenshot should be take from a user named Walter O'Brien. You can change the name of your current user by going to your Appwrite Console and clicking the **top right profile icon** > **Your Account** > **Name**.
+- All screenshot should be taken from a user named Walter O'Brien. You can change the name of your current user by going to your Appwrite Console and clicking the **top right profile icon** > **Your Account** > **Name**.
 - Screenshots are stored in the `/images/docs/` folder, in a parent folder that is consistent with the path of the docs that reference the image.
-- All screenshots must be both dark and light mode, with `/path/` holding the lightmode version and `/path/dark/` holding the dark mode version.
+- All screenshots must be both dark and light mode, with `/path/` holding the light-mode version and `/path/dark/` holding the dark mode version.
 - Screenshots should be uploaded as un-edited original. Request help from the Appwrite design team to help you edit and refine your photos according to our guidelines.
 
 ```md

src/markdoc/nodes/Image.svelte

@@ -42,7 +42,7 @@
     {/if}
 {:else}
     <div class="web-media main">
-        <img {src} {alt} {title} loading="lazy" class="aspect-video w-full" />
+        <img {src} {alt} {title} loading="lazy" class="aspect-video w-full object-cover" />
         <div class="abs">
             <Tooltip closeOnPointerDown>
                 <Button variant="secondary" class="cursor-pointer" action={trigger}>

src/routes/blog/post/announcing-csv-imports/+page.markdoc

@@ -0,0 +1,69 @@
+---
+layout: post
+title: "Announcing: Document imports from CSV files"
+description: Learn how to import documents into your Appwrite collections using a simple CSV file, a new feature built on top of Appwrite's migration APIs.
+date: 2025-07-01
+# update this cover later, once available!
+cover: /images/blog/announcing-csv-imports/cover.png
+timeToRead: 5
+author: darshan-pandya
+category: announcement
+featured: false
+---
+
+We're introducing a new way to populate your Appwrite databases: **document imports from CSV files**.
+
+Built on top of Appwrite's migration APIs, this feature makes it easy to bring in large datasets, seed collections, or migrate structured data using only a CSV file.
+
+The CSV document import is useful for migrating user data from external systems, importing inventory records, seeding test environments, or onboarding structured content such as FAQs.
+
+# How it works
+
+To get started, create a collection and define its attributes in the Appwrite Console. Your CSV file should follow a standard format:
+
+- The first row must be a header containing attribute names that match your collection
+- Each subsequent row represents a document, with values separated by commas
+
+{% info title="Good to know" %}
+You can optionally include the `$id` column to assign custom document IDs.
+{% /info %}
+
+![Collections screen](/images/blog/announcing-csv-imports/csv-import.png)
+
+All required attributes must be present in the CSV, and Appwrite will validate each row before importing it.
+
+For example, if your collection contains attributes like `title`, `author`, `year`, and `available`, a valid CSV file would look like this:
+
+```text
+$id,title,author,year,available
+f3k91x8b2q,Harry Potter and the Sorcerer's Stone,J.K. Rowling,1997,true
+mz7lq3dp5c,The Fellowship of the Ring,J.R.R. Tolkien,1954,true
+x0v4p8ncq2,To Kill a Mockingbird,Harper Lee,1960,false
+kq9nmv13ru,The Great Gatsby,F. Scott Fitzgerald,1925,true
+p8lw39xsd1,Catch-22,Joseph Heller,1961,true
+v42cj0quxp,Pride and Prejudice,Jane Austen,1813,true
+```
+
+## Uploading your CSV file
+
+You can upload a new file during import or select an existing one from your project's storage bucket.
+The Console provides a guided interface to help you select the CSV and link it to your target collection. Once uploaded, the import process begins immediately.
+
+## Designed for scale
+
+CSV imports are built to scale seamlessly with your data. Whether you're working with a small dataset or importing production-grade records, the system is designed to handle high volumes reliably and efficiently.
+
+The import system performs per-row validation and runs as a background task, allowing it to handle large files efficiently. This ensures reliable performance across a range of scenarios—from lightweight configuration data to large-scale production imports.
+
+## Availability and resources
+
+CSV imports are now available on **Appwrite Cloud** and in the latest self-hosted release.
+
+To learn more, check out the [official documentation](/docs/products/databases/csv-imports).
+If you have any questions or feedback, we'd love to hear from you in the [Appwrite Discord community](https://discord.gg/appwrite).
+
+# Further reading
+
+- [Introducing Database Backups](https://appwrite.io/blog/post/introducing-database-backups?doFollow=true)
+- [Best database pagination technique](https://appwrite.io/blog/post/best-pagination-technique?doFollow=true)
+- [How to plan and execute database migration successfully with the new Appwrite CLI](https://appwrite.io/blog/post/how-to-execute-database-migration-with-appwrite-cli?doFollow=true)

src/routes/docs/products/databases/+layout.svelte

@@ -1,5 +1,6 @@
 <script lang="ts">
     import Docs from '$lib/layouts/Docs.svelte';
+    import { isNewUntil } from '$lib/utils/date';
     import Sidebar, { type NavParent, type NavTree } from '$lib/layouts/Sidebar.svelte';
 
     const parent: NavParent = {
@@ -42,7 +43,8 @@
                 },
                 {
                     label: 'Type Generation',
-                    href: '/docs/products/databases/type-generation'
+                    href: '/docs/products/databases/type-generation',
+                    new: isNewUntil('31 Jul 2025')
                 },
                 {
                     label: 'Offline Sync',
@@ -55,6 +57,11 @@
                 {
                     label: 'Backups',
                     href: '/docs/products/databases/backups'
+                },
+                {
+                    label: 'CSV Imports',
+                    href: '/docs/products/databases/csv-imports',
+                    new: isNewUntil('31 Jul 2025')
                 }
             ]
         },

src/routes/docs/products/databases/csv-imports/+page.markdoc

@@ -0,0 +1,63 @@
+---
+layout: article
+title: CSV Imports
+description: Master document imports with Appwrite's CSV Import feature. Learn how to create documents within your collections by uploading a CSV file.
+---
+
+Appwrite's CSV Import feature allows you to create multiple documents in a collection by uploading a single CSV file. This is especially useful for importing existing data, seeding test environments, or migrating from other systems.
+
+This feature is available in both Appwrite Cloud and the self-hosted version.
+
+# Prepare your collection {% #prepare-collection %}
+
+To get started, create a collection in your database and define its attributes. Your CSV file must match the structure of this collection.
+
+Each column in the CSV should map to an attribute key in your collection, and each row should represent a new document.
+
+{% info title="Good to know" %}
+You can optionally include the `$id` column to define custom document IDs. If not provided, Appwrite will generate unique IDs for each document automatically.
+{% /info %}
+For example, if your collection has the following required attributes:
+
+- `title` (string)
+- `author` (string)
+- `year` (integer)
+- `available` (boolean)
+
+A valid CSV file might look like:
+
+```text
+$id,title,author,year,available
+f3k91x8b2q,Harry Potter and the Sorcerer's Stone,J.K. Rowling,1997,true
+mz7lq3dp5c,The Fellowship of the Ring,J.R.R. Tolkien,1954,true
+x0v4p8ncq2,To Kill a Mockingbird,Harper Lee,1960,false
+```
+
+{% info title="Note" %}
+All required attributes must be present in the CSV. Each row is validated before being imported.
+{% /info %}
+
+
+# Import documents from the Console {% #import-console %}
+
+To import documents using the Appwrite Console:
+
+1. Go to your project -> Databases
+2. Navigate to your target Collection
+3. Click on the **Import CSV** button in the action area
+4. Upload a new CSV file or choose an existing file from your Storage bucket
+
+{% only_dark %}
+![CSV import screen](/images/docs/databases/dark/csv-import.png)
+{% /only_dark %}
+{% only_light %}
+![CSV import screen](/images/docs/databases/csv-import.png)
+{% /only_light %}
+
+CSV imports run as background tasks. The Console displays a floating progress bar while the import is active.
+
+# Additional resources {% #additional-resources %}
+
+- [Appwrite CLI for Migrations](/docs/command-line-tools)
+- [Database Permissions](/docs/products/databases/permissions)
+- [Documents API Reference](/docs/references/cloud/client-web/databases)

src/routes/docs/products/databases/documents/+page.markdoc

@@ -149,7 +149,7 @@ import { Client, Databases, Query } from "appwrite";
 
 const client = new Client()
     .setEndpoint("https://<REGION>.cloud.appwrite.io/v1")
-    .setProject("<PROJECT_ID>")
+    .setProject("<PROJECT_ID>");
 
 const databases = new Databases(client);