|
| 1 | +--- |
| 2 | +layout: article |
| 3 | +title: CSV exports |
| 4 | +description: Export table data to CSV files from the Console. Share clean datasets with your team without writing custom scripts. |
| 5 | +--- |
| 6 | + |
| 7 | +Appwrite's CSV Export feature allows you to export rows from a table to a CSV file. This is especially useful for reporting, sharing data with non-technical team members, creating custom backups, or handing off datasets to analytics tools. |
| 8 | + |
| 9 | +This feature is available in both Appwrite Cloud and the self-hosted version. |
| 10 | + |
| 11 | +# Export configuration {% #export-configuration %} |
| 12 | + |
| 13 | +Before exporting, you can configure several options to control the output format and contents. These settings ensure you get exactly the data you need in the format your tools expect. |
| 14 | + |
| 15 | +## Apply filters {% #apply-filters %} |
| 16 | + |
| 17 | +You can apply filters to your table from the table view and use those to export only the rows you need. This is especially useful when you want to export a subset of your data for a specific use case. |
| 18 | + |
| 19 | +## Select columns {% #select-columns %} |
| 20 | + |
| 21 | +You can choose which columns to include in your export. By default, all columns are exported, but selecting specific columns creates cleaner, more focused datasets that are easier to work with in spreadsheets and analytics tools. |
| 22 | + |
| 23 | +{% info title="Good to know" %} |
| 24 | +System columns like `$id`, `$createdAt`, and `$updatedAt` are automatically included in the export. |
| 25 | +{% /info %} |
| 26 | + |
| 27 | +## Custom delimiter {% #custom-delimiter %} |
| 28 | + |
| 29 | +You can set a custom delimiter for your CSV file. While commas are standard, you can use tabs, semicolons, or other delimiters based on your requirements or the tools you're importing into. |
| 30 | + |
| 31 | +Common delimiters: |
| 32 | +- **Comma (`,`)**: Standard format, compatible with most tools |
| 33 | +- **Tab**: Useful when your data contains many commas |
| 34 | +- **Semicolon (`;`)**: Common in European Excel versions |
| 35 | +- **Pipe (`|`)**: Useful when your data contains many semicolons |
| 36 | + |
| 37 | +## Header row {% #header-row %} |
| 38 | + |
| 39 | +You can choose whether to include a header row with column names. Headers make it easier to understand the data in spreadsheets, but some import tools work better without them. |
| 40 | + |
| 41 | +# Relationship handling {% #relationship-handling %} |
| 42 | + |
| 43 | +When exporting data that includes [relationships](/docs/products/databases/relationships) to other tables, Appwrite exports only the related row IDs by default. This keeps your CSV files clean and prevents deeply nested data structures that can break spreadsheet tools. |
| 44 | + |
| 45 | +For example, if you have a `posts` table with a relationship to an `authors` table, the export will include the author ID rather than all author details. |
| 46 | + |
| 47 | +An example of exported data with relationships: |
| 48 | + |
| 49 | +```text |
| 50 | +$id,title,author_id,published |
| 51 | +post-1,Getting started with Appwrite,user-123,true |
| 52 | +post-2,Advanced queries,user-456,true |
| 53 | +post-3,CSV exports guide,user-123,false |
| 54 | +``` |
| 55 | + |
| 56 | +# Timestamps {% #timestamps %} |
| 57 | + |
| 58 | +The `$createdAt` and `$updatedAt` columns are exported in ISO 8601 format, making them compatible with most spreadsheet and database tools. |
| 59 | + |
| 60 | +# Permissions {% #permissions %} |
| 61 | + |
| 62 | +If row-level security is enabled for your table, the `$permissions` column will be included in the export. Permission strings are formatted as comma-separated role definitions within quotes. |
| 63 | + |
| 64 | +```text |
| 65 | +$id,title,$permissions |
| 66 | +post-1,Public post,"read(""any""),update(""user:user-123"")" |
| 67 | +post-2,Team post,"read(""team:team-456""),update(""team:team-456"")" |
| 68 | +``` |
| 69 | + |
| 70 | +The roles used are API strings that can be found in the [permissions documentation](/docs/products/databases/permissions). |
| 71 | + |
| 72 | +# Background processing {% #background-processing %} |
| 73 | + |
| 74 | +Large exports run as background tasks to avoid blocking your workflow. When an export completes, you'll receive an email with a short-lived download link to retrieve your CSV file. |
| 75 | + |
| 76 | +This means you can start an export, close the Console, and return later to download your file. The Console displays a floating progress bar while the export is active. |
| 77 | + |
| 78 | +# Export from the Console {% #export-console %} |
| 79 | + |
| 80 | +To export rows using the Appwrite Console: |
| 81 | + |
| 82 | +1. Go to your project and navigate to **Databases** |
| 83 | +2. Select your target database and navigate to your target table |
| 84 | +3. Click on the **Export CSV** button in the action area |
| 85 | +4. Configure your export options: |
| 86 | + - Choose which columns to include (optional) |
| 87 | + - Set your preferred delimiter |
| 88 | + - Choose whether to include headers |
| 89 | +5. Click **Export** |
| 90 | + |
| 91 | +{% only_dark %} |
| 92 | + |
| 93 | +{% /only_dark %} |
| 94 | +{% only_light %} |
| 95 | + |
| 96 | +{% /only_light %} |
| 97 | + |
| 98 | +The export will begin processing in the background. You'll see a progress indicator and receive an email when the export is ready to download. |
| 99 | + |
| 100 | +# Use cases {% #use-cases %} |
| 101 | + |
| 102 | +CSV exports are useful for many common workflows: |
| 103 | + |
| 104 | +- **Reporting**: Generate reports for stakeholders who need data in spreadsheet format |
| 105 | +- **Data sharing**: Share clean datasets with non-technical team members |
| 106 | +- **Analytics hand-off**: Provide datasets to analysts using BI tools |
| 107 | +- **Compliance exports**: Create audit trails and compliance records |
| 108 | +- **Custom backups**: Archive specific data subsets for record-keeping |
| 109 | +- **Migration preparation**: Extract data for migration to other systems |
| 110 | + |
| 111 | +# Best practices {% #best-practices %} |
| 112 | + |
| 113 | +To get the most out of CSV exports: |
| 114 | + |
| 115 | +1. **Use filters to filter data**: Export only the rows you need to reduce file size and processing time |
| 116 | +2. **Select specific columns**: Choose relevant columns to create cleaner, more focused datasets |
| 117 | +4. **Choose appropriate delimiters**: Use tabs or semicolons if your data contains many commas |
| 118 | +5. **Consider header requirements**: Include headers for human readability, exclude them for automated imports |
| 119 | + |
| 120 | +# Additional resources {% #additional-resources %} |
| 121 | + |
| 122 | +- [CSV Imports](/docs/products/databases/csv-imports) - Import data from CSV files |
| 123 | +- [Relationships](/docs/products/databases/relationships) - Define connections between tables |
| 124 | +- [Database Permissions](/docs/products/databases/permissions) - Configure row-level security |
| 125 | +- [Database Backups](/docs/products/databases/backups) - Automated backup policies |
0 commit comments