-
Notifications
You must be signed in to change notification settings - Fork 327
Databases Documentation #3072
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
atharvadeosthale
wants to merge
2
commits into
stardust
Choose a base branch
from
stardust-databases
base: stardust
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+9,545
−63
Open
Databases Documentation #3072
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
64 changes: 64 additions & 0 deletions
64
src/routes/docs/products/databases/(overview)/+layout.svelte
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| <script lang="ts"> | ||
| import Docs from '$lib/layouts/Docs.svelte'; | ||
| import Sidebar, { type NavParent, type NavTree } from '$lib/layouts/Sidebar.svelte'; | ||
|
|
||
| let { children } = $props(); | ||
|
|
||
| const parent: NavParent = { | ||
| href: '/docs', | ||
| label: 'Databases' | ||
| }; | ||
|
|
||
| const navigation: NavTree = [ | ||
| { | ||
| label: 'Getting started', | ||
| items: [ | ||
| { | ||
| label: 'Overview', | ||
| href: '/docs/products/databases' | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| label: 'Appwrite databases', | ||
| items: [ | ||
| { | ||
| label: 'TablesDB', | ||
| href: '/docs/products/databases/tablesdb', | ||
| isParent: true | ||
| }, | ||
| { | ||
| label: 'DocumentsDB', | ||
| href: '/docs/products/databases/documentsdb', | ||
| isParent: true | ||
| }, | ||
| { | ||
| label: 'VectorsDB', | ||
| href: '/docs/products/databases/vectorsdb', | ||
| isParent: true | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| label: 'Native databases', | ||
| items: [ | ||
| { | ||
| label: 'PostgreSQL', | ||
| href: '/docs/products/databases/postgresql', | ||
| isParent: true | ||
| }, | ||
| { | ||
| label: 'MySQL', | ||
| href: '/docs/products/databases/mysql', | ||
| isParent: true | ||
| } | ||
| ] | ||
| } | ||
| ]; | ||
| </script> | ||
|
|
||
| <Docs variant="two-side-navs"> | ||
| <Sidebar {navigation} {parent} /> | ||
|
|
||
| {@render children()} | ||
| </Docs> |
40 changes: 40 additions & 0 deletions
40
src/routes/docs/products/databases/(overview)/+page.markdoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| --- | ||
| layout: article | ||
| title: Databases | ||
| description: Store and query your application data with Appwrite Databases. Choose between Appwrite databases with managed APIs and dedicated native databases with direct access. | ||
| --- | ||
|
|
||
| Appwrite Databases provide performant and scalable storage for your application, business, and user data. Choose the database that fits your use case, from managed APIs with permissions and realtime to dedicated native engines you connect to directly. | ||
|
|
||
| {% info title="Looking for file storage?" %} | ||
| Databases store data. If you need to store files like images, PDFs, or videos, use [Appwrite Storage](/docs/products/storage). | ||
| {% /info %} | ||
|
|
||
| # Appwrite databases {% #appwrite-databases %} | ||
|
|
||
| Managed databases with an Appwrite API on top, including permissions, indexes, queries, and realtime. Available on shared and dedicated infrastructure. | ||
|
|
||
| {% cards %} | ||
| {% cards_item href="/docs/products/databases/tablesdb" title="TablesDB" %} | ||
| Structured, relational data with typed columns, rows, relationships, and indexes. | ||
| {% /cards_item %} | ||
| {% cards_item href="/docs/products/databases/documentsdb" title="DocumentsDB" %} | ||
| Schemaless document storage for flexible, JSON-style data. | ||
| {% /cards_item %} | ||
| {% cards_item href="/docs/products/databases/vectorsdb" title="VectorsDB" %} | ||
| Store embeddings and run similarity search to power AI features. | ||
| {% /cards_item %} | ||
| {% /cards %} | ||
|
|
||
| # Native databases {% #native-databases %} | ||
|
|
||
| Native database engines provisioned for your project with direct connection access and no abstraction layer. Available on dedicated infrastructure. | ||
|
|
||
| {% cards %} | ||
| {% cards_item href="/docs/products/databases/postgresql" title="PostgreSQL" %} | ||
| A dedicated, native PostgreSQL database you connect to directly. | ||
| {% /cards_item %} | ||
| {% cards_item href="/docs/products/databases/mysql" title="MySQL" %} | ||
| A dedicated, native MySQL database you connect to directly. | ||
| {% /cards_item %} | ||
| {% /cards %} |
91 changes: 91 additions & 0 deletions
91
src/routes/docs/products/databases/documentsdb/+layout.svelte
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| <script lang="ts"> | ||
| import Docs from '$lib/layouts/Docs.svelte'; | ||
| import Sidebar, { type NavParent, type NavTree } from '$lib/layouts/Sidebar.svelte'; | ||
| let { children } = $props(); | ||
| const parent: NavParent = { | ||
| href: '/docs/products/databases', | ||
| label: 'DocumentsDB' | ||
| }; | ||
| const navigation: NavTree = [ | ||
| { | ||
| label: 'Getting started', | ||
| items: [ | ||
| { | ||
| label: 'Overview', | ||
| href: '/docs/products/databases/documentsdb' | ||
| }, | ||
| { | ||
| label: 'Quick start', | ||
| href: '/docs/products/databases/documentsdb/quick-start' | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| label: 'Concepts', | ||
| items: [ | ||
| { | ||
| label: 'Databases', | ||
| href: '/docs/products/databases/documentsdb/databases' | ||
| }, | ||
| { | ||
| label: 'Collections', | ||
| href: '/docs/products/databases/documentsdb/collections' | ||
| }, | ||
| { | ||
| label: 'Documents', | ||
| href: '/docs/products/databases/documentsdb/documents' | ||
| }, | ||
| { | ||
| label: 'Permissions', | ||
| href: '/docs/products/databases/documentsdb/permissions' | ||
| }, | ||
| { | ||
| label: 'Queries', | ||
| href: '/docs/products/databases/documentsdb/queries' | ||
| }, | ||
| { | ||
| label: 'Order', | ||
| href: '/docs/products/databases/documentsdb/order' | ||
| }, | ||
| { | ||
| label: 'Backups', | ||
| href: '/docs/products/databases/documentsdb/backups' | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| label: 'Journeys', | ||
| items: [ | ||
| { | ||
| label: 'Pagination', | ||
| href: '/docs/products/databases/documentsdb/pagination' | ||
| }, | ||
| { | ||
| label: 'Transactions', | ||
| href: '/docs/products/databases/documentsdb/transactions' | ||
| }, | ||
| { | ||
| label: 'Bulk operations', | ||
| href: '/docs/products/databases/documentsdb/bulk-operations' | ||
| }, | ||
| { | ||
| label: 'Atomic numeric operations', | ||
| href: '/docs/products/databases/documentsdb/atomic-numeric-operations' | ||
| }, | ||
| { | ||
| label: 'Timestamp overrides', | ||
| href: '/docs/products/databases/documentsdb/timestamp-overrides' | ||
| } | ||
| ] | ||
| } | ||
| ]; | ||
| </script> | ||
|
|
||
| <Docs variant="two-side-navs"> | ||
| <Sidebar {navigation} {parent} /> | ||
|
|
||
| {@render children()} | ||
| </Docs> | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
parent.labelfor DocumentsDB is set to'DocumentsDB'but theparent.hrefpoints to/docs/products/databases(the Databases overview). The Sidebar renders this label as a visible section heading above a back-arrow link. Every other database sub-product layout —tablesdb,mysql,postgresql,vectorsdb— correctly useslabel: 'Databases'for this same parent href, so DocumentsDB users would see a confusing "DOCUMENTSDB" label where they'd expect "DATABASES".