Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update shuttle-shared-db.mdx #93

Merged
merged 1 commit into from
May 9, 2023
Merged

Update shuttle-shared-db.mdx #93

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions resources/shuttle-shared-db.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@ This plugin manages databases that are shared with other services on [shuttle](h
will share a postgres server with other users, but it will not be accessible by other users.

## Usage
Add `shuttle-shared-db` to the dependencies for your service. Every type of shareable database is behind the following feature flag and attribute path

| Engine | Feature flag | Attribute path |
|----------|--------------|-----------------------------|
| Postgres | postgres | shuttle_shared_db::Postgres |
| MongoDB | mongodb | shuttle_shared_db::MongoDb |
Add `shuttle-shared-db` to the dependencies for your service. Every type of shareable database
is behind the following feature flag and attribute path. `*-rustls` feature enables `rustls`-based implementation,
otherwise some flavour of `native-tls` is used.

| Engine | Feature flags | Attribute path |
|----------|-------------------------------|-------------------------------|
| Postgres | `postgres`, `postgres-rustls` | `shuttle_shared_db::Postgres` |
| MongoDB | `mongodb` | `shuttle_shared_db::MongoDb` |

### Parameters
| Parameter | Type | Default | Description |
Expand Down