diff --git a/docs/concepts/access-control.md b/docs/concepts/access-control.md index 016a14f2..b2a59350 100644 --- a/docs/concepts/access-control.md +++ b/docs/concepts/access-control.md @@ -42,31 +42,31 @@ The following table describes permissions assigned at the organization level for | Action | Description | Member | Administrator | | -------------------------------------- | ------------------------------------------------------------------------------ | ------ | ------------- | -| View branches | View a database branch | ✔ | ✔ | -| Create branches | Create a database branch | ✔ | ✔ | -| Delete non-production branches | Delete a non-production database branch | ✔ | ✔ | -| View databases | View one or all databases | ✔ | ✔ | -| Create databases | Create a new database | ✔ | ✔ | -| Create deploy requests | Create a deploy request for a branch | ✔ | ✔ | -| Manage service tokens | Create, view, or delete service tokens | ✔ | ✔ | -| Manage service token grants | Create, view, update, or delete service token grants | ✔ | ✔ | -| View organization members | View one or all organization members | ✔ | ✔ | -| View database members | View one or all database members | ✔ | ✔ | -| View organization | View an organization | ✔ | ✔ | -| View query statistics | View query statistics for an organization's databases | ✔ | ✔ | -| Delete production branches | Delete a production database branch | | ✔ | -| Promote branches | Promote a branch to production | | ✔ | -| Manage databases | Delete, update settings, or import a database | | ✔ | -| Manage beta features | Opt-in or opt-out of a beta feature | | ✔ | -| Create production service token grants | Create a service token grant to connect or delete a production database branch | | ✔ | -| Update an integration | Update a third-party integration | | ✔ | -| Manage invitations | View, create, or cancel organization invitations | | ✔ | -| Manage invoices | View or download organization invoices | | ✔ | -| Manage billing | View or update billing plans and payment methods | | ✔ | -| View audit logs | View all audit logs | | ✔ | -| Manage organization members | Update member roles or delete organization members | | ✔ | -| Manage database members | Update member roles, add, or remove database members | | ✔ | -| Manage organization | Update organization settings, SSO, or delete organization | | ✔ | +| View branches | View a database branch | ✔ | ✔ | +| Create branches | Create a database branch | ✔ | ✔ | +| Delete non-production branches | Delete a non-production database branch | ✔ | ✔ | +| View databases | View one or all databases | ✔ | ✔ | +| Create databases | Create a new database | ✔ | ✔ | +| Create deploy requests | Create a deploy request for a branch | ✔ | ✔ | +| Manage service tokens | Create, view, or delete service tokens | ✔ | ✔ | +| Manage service token grants | Create, view, update, or delete service token grants | ✔ | ✔ | +| View organization members | View one or all organization members | ✔ | ✔ | +| View database members | View one or all database members | ✔ | ✔ | +| View organization | View an organization | ✔ | ✔ | +| View query statistics | View query statistics for an organization's databases | ✔ | ✔ | +| Delete production branches | Delete a production database branch | | ✔ | +| Promote branches | Promote a branch to production | | ✔ | +| Manage databases | Delete, update settings, or import a database | | ✔ | +| Manage beta features | Opt-in or opt-out of a beta feature | | ✔ | +| Create production service token grants | Create a service token grant to connect or delete a production database branch | | ✔ | +| Update an integration | Update a third-party integration | | ✔ | +| Manage invitations | View, create, or cancel organization invitations | | ✔ | +| Manage invoices | View or download organization invoices | | ✔ | +| Manage billing | View or update billing plans and payment methods | | ✔ | +| View audit logs | View all audit logs | | ✔ | +| Manage organization members | Update member roles or delete organization members | | ✔ | +| Manage database members | Update member roles, add, or remove database members | | ✔ | +| Manage organization | Update organization settings, SSO, or delete organization | | ✔ | ## Database-level permissions @@ -76,20 +76,20 @@ For `Organization Administrators` and `Organization Members`, these permissions | Action | Description | Member | Administrator | | ------------------------------ | ------------------------------------------------------------- | ------ | ------------- | -| Create and view branches | Create or view a database branch | ✔ | ✔ | -| Delete non-production branches | Delete a non-production branch of a specific database | ✔ | ✔ | -| View database | View a database in an organization | ✔ | ✔ | -| Create deploy requests | Create a deploy request for a branch on a specific database | ✔ | ✔ | -| View database members | View one or all database members | ✔ | ✔ | -| View query statistics | View query statistics for an organization's databases | ✔ | ✔ | -| Restore non-production backups | Restore the backup of a development branch | ✔ | ✔ | -| Manage billing | Update the billing plan of a specific database | | ✔ | -| Delete production branches | Delete a production database branch of a specific database | | ✔ | -| Promote branches | Promote a branch of a specific database to production | | ✔ | -| Manage database | Delete, update settings, or import a database | | ✔ | -| Manage beta features | Opt-in or opt-out of a beta feature for a database | | ✔ | -| Manage database members | Update database member roles, add, or remove database members | | ✔ | -| Restore production backups | Restore the backup of a production branch | | ✔ | +| Create and view branches | Create or view a database branch | ✔ | ✔ | +| Delete non-production branches | Delete a non-production branch of a specific database | ✔ | ✔ | +| View database | View a database in an organization | ✔ | ✔ | +| Create deploy requests | Create a deploy request for a branch on a specific database | ✔ | ✔ | +| View database members | View one or all database members | ✔ | ✔ | +| View query statistics | View query statistics for an organization's databases | ✔ | ✔ | +| Restore non-production backups | Restore the backup of a development branch | ✔ | ✔ | +| Manage billing | Update the billing plan of a specific database | | ✔ | +| Delete production branches | Delete a production database branch of a specific database | | ✔ | +| Promote branches | Promote a branch of a specific database to production | | ✔ | +| Manage database | Delete, update settings, or import a database | | ✔ | +| Manage beta features | Opt-in or opt-out of a beta feature for a database | | ✔ | +| Manage database members | Update database member roles, add, or remove database members | | ✔ | +| Restore production backups | Restore the backup of a production branch | | ✔ | An organization may have several databases, and an `Organization Member` may have different access to each database depending on whether or not they also have the `Database Administrator` role. diff --git a/docs/concepts/billing.md b/docs/concepts/billing.md index a5dff55a..3a177f46 100644 --- a/docs/concepts/billing.md +++ b/docs/concepts/billing.md @@ -61,7 +61,7 @@ The usage-based plans are summarized below: | **Audit log retention** | 5 days | 15 days | | **Automatic backups** | Daily | Every 12 hours | | **Support** | Community | Standard | -| [**Data Branching®**](/docs/concepts/data-branching) | Not included | Not included | +| [**Data Branching®**](/docs/concepts/data-branching) | Not included | Not included | | **Monthly cost** | $0 | $29 per database | | [**PlanetScale Boost**](/docs/concepts/query-caching-with-planetscale-boost) | Not included | Available as an add-on | @@ -207,7 +207,7 @@ All Scaler Pro plans, regardless of cluster size, share the following features: | **Audit log retention** | 15 days | | **Automatic backups** | Every 12 hours | | **Support** | Standard, upgrade available\*\*\* | -| [**Data Branching®**](/docs/concepts/data-branching) | Included | +| [**Data Branching®**](/docs/concepts/data-branching) | Included | | [**PlanetScale Boost**](/docs/concepts/query-caching-with-planetscale-boost) | Available as an add-on | \* For the Scaler Pro plan, any storage over the included amount is billed at $1.50 per additional 1 GB. @@ -244,7 +244,7 @@ The Enterprise plan is fully customizable to suit your businesses needs. For mor | **Audit log retention** | Configurable | | **Automated Backups** | Configurable | | **Support** | Business, upgrade available\* | -| [**Data Branching®**](/docs/concepts/data-branching) | Included | +| [**Data Branching®**](/docs/concepts/data-branching) | Included | | [**PlanetScale Boost**](/docs/concepts/query-caching-with-planetscale-boost) | Available as an add-on | | **Monthly cost** | Custom | diff --git a/docs/concepts/network-latency.md b/docs/concepts/network-latency.md index 1dff44c6..0eaf8f1c 100644 --- a/docs/concepts/network-latency.md +++ b/docs/concepts/network-latency.md @@ -64,6 +64,7 @@ This does not apply to PlanetScale Managed and single-tenant customers who have PlanetScale's optimized hostname uses Route 53's [latency-based](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy-latency.html) routing to connect to the closest edge in PlanetScale's network. Using this hostname optimizes latency and improves reliability as it can route around regional network outages. Examples of optimized hostnames: + - `aws.connect.psdb.cloud` - `gcp.connect.psdb.cloud` diff --git a/docs/concepts/password-roles.md b/docs/concepts/password-roles.md index 6fd69294..f9b3645b 100644 --- a/docs/concepts/password-roles.md +++ b/docs/concepts/password-roles.md @@ -28,10 +28,10 @@ The access level available to these roles is shown in the table below. | Role name | Can create/edit schema | Can insert/update/delete rows | Can query rows | | :--------- | :--------------------- | :---------------------------- | :------------- | -| Read-only | ❌ | ❌ | ✔ | -| Write-only | ❌ | ✔ | ❌ | -| Read/write | ❌ | ✔ | ✔ | -| Admin | ✔ | ✔ | ✔ | +| Read-only | ❌ | ❌ | ✔ | +| Write-only | ❌ | ✔ | ❌ | +| Read/write | ❌ | ✔ | ✔ | +| Admin | ✔ | ✔ | ✔ | {% callout %} The default role for all passwords created by the **Connect** button is `Administrator`. Passwords with custom roles diff --git a/docs/concepts/planetscale-plans.md b/docs/concepts/planetscale-plans.md index b6890687..a7f84f0c 100644 --- a/docs/concepts/planetscale-plans.md +++ b/docs/concepts/planetscale-plans.md @@ -36,7 +36,7 @@ Self-serve is comprised of three plans that you can sign up for from the PlanetS | **Audit log retention** | 5 days | 15 days | | **Automatic backups** | Daily | Every 12 hours | | **Support** | Community | Standard | -| [**Data Branching®**](/docs/concepts/data-branching) | Not included | Not included | +| [**Data Branching®**](/docs/concepts/data-branching) | Not included | Not included | | **Monthly cost** | $0 | $29 per database | | [**PlanetScale Boost**](/docs/concepts/query-caching-with-planetscale-boost) | Not included | Available as an add-on | @@ -76,7 +76,7 @@ On top of processing and memory, all **Scaler Pro** cluster sizes share the foll | **Audit log retention** | 15 days | | **Automatic backups** | Every 12 hours | | **Support** | Standard, upgrade available\*\*\* | -| [**Data Branching®**](/docs/concepts/data-branching) | Included | +| [**Data Branching®**](/docs/concepts/data-branching) | Included | | [**PlanetScale Boost**](/docs/concepts/query-caching-with-planetscale-boost) | Available as an add-on | \* For the Scaler Pro plan, any storage over the included amount is billed at $1.50 per additional 1 GB. @@ -137,13 +137,13 @@ PlanetScale's Enterprise Plan is great for users that want to scale farther, sha | | **Multi-Tenant** | **Single-Tenant** | **Managed** | | --------------------------- | ---------------- | ----------------- | ----------- | -| Resource-based pricing | ✔ | ✔ | ✔ | -| Horizontal sharding | ✔ | ✔ | ✔ | -| Unlimited connections | ✔ | ✔ | ✔ | -| Customizable feature limits | ✔ | ✔ | ✔ | -| BAAs available | ❌ | ✔ | ✔ | -| Dedicated AWS/GCP account | ❌ | ✔ | ✔ | -| Your own AWS/GCP account | ❌ | ❌ | ✔ | +| Resource-based pricing | ✔ | ✔ | ✔ | +| Horizontal sharding | ✔ | ✔ | ✔ | +| Unlimited connections | ✔ | ✔ | ✔ | +| Customizable feature limits | ✔ | ✔ | ✔ | +| BAAs available | ❌ | ✔ | ✔ | +| Dedicated AWS/GCP account | ❌ | ✔ | ✔ | +| Your own AWS/GCP account | ❌ | ❌ | ✔ | ## How do I know if I need an Enterprise plan? diff --git a/docs/onboarding/create-a-database.md b/docs/onboarding/create-a-database.md index 78889a1e..37b28f21 100644 --- a/docs/onboarding/create-a-database.md +++ b/docs/onboarding/create-a-database.md @@ -19,21 +19,23 @@ A schema refers to the structure of the database. The most common parts of a sch ## Create a database -If you’ve come here directly from creating your account, you should on your organization's overview page where you can choose to either: Create a new database or import a database. +If you’ve come here directly from creating your account, you should on your organization's overview page where you can choose to either: Create a new database or import a database. -Click the button to **"Create a new database"**. +Click the button to **"Create a new database"**. + +On the next page, you will need to: -On the next page, you will need to: - Name the database `beam-demo`. - Select a region. There are several geographical regions you can host your database in. You will want to select the region closest to your application servers connecting to the database. - Select the desired [Plan type](/docs/concepts/billing#planetscale-plans) for your database. -- Add a valid credit or debit card to your account. In order to prevent fraud, PlanetScale requires a valid payment method to create databases. You will not be charged unless you create a Scaler or Scaler Pro database. +- Add a valid credit or debit card to your account. In order to prevent fraud, PlanetScale requires a valid payment method to create databases. You will not be charged unless you create a Scaler or Scaler Pro database. Then, click **"Create database"**. For the next step to create a table, you can select the option to connect to the database later with "**I’ll do this later**" button. Next, you’ll be dropped into the dashboard for that specific database. Let's take a look at the layout and what each element does before moving on. The tabs from left to right are: + - **Overview** — The current tab showing an overview of your database. - **Deploy requests** — How you apply changes to your database schema. More on that in the next article. - **Branches** — View the different branches of your database. Again, more on that in the next article. @@ -43,7 +45,8 @@ The tabs from left to right are: - **Backups** — Shows you backup schedule and all backups for this database across production and development branches. - **Settings** — Lets you tweak various aspects of your database like who has access to it, beta feature opt-ins, and plan management. -Two other important buttons are: +Two other important buttons are: + - **New branch** — Allows you to create a new branch of your schema. - **Connect** — Provides connection details that applications can use to connect to your database.