Skip to content

Commit

Permalink
docs: upstream
Browse files Browse the repository at this point in the history
  • Loading branch information
planetscale-actions-bot committed Aug 3, 2023
1 parent b00fbe9 commit bd79b5f
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 6 deletions.
9 changes: 9 additions & 0 deletions docs/concepts/billing.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ PlanetScale applies billing plans at the **database level**. You can create seve
We used **[gibibytes, otherwise known as binary gigabytes](https://simple.wikipedia.org/wiki/Gibibyte)**, to calculate storage and usage limits. For reference, 1 binary gigabyte is equivalent to 2^30 bytes.
{% /callout %}

### Payment methods

You can add a debit or credit card to your PlanetScale organization to pay your invoices, but we do not accept pre-paid cards.

## Usage-based plans

PlanetScale provides two usage-based plans: `Hobby` and `Scaler`. These plans are charged on three factors:
Expand All @@ -28,6 +32,11 @@ PlanetScale provides two usage-based plans: `Hobby` and `Scaler`. These plans ar

See the ["Understanding rows read" section](#understanding-rows-read) for a more in-depth look at the rows read calculation.

{% callout %}
In order to prevent fraud, PlanetScale requires a valid payment method in order to create databases on the Hobby (free) tier.
You will not be charged unless you create a Scaler or Scaler Pro database.
{% /callout %}

Some limitations apply to the free tier. See below for more information.

The usage-based plans are summarized below:
Expand Down
5 changes: 5 additions & 0 deletions docs/concepts/planetscale-plans.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,11 @@ If you are unsure as to which plan or cluster size is right for your application

Our self-serve plans are flexible enough to handle the majority of customers. However, there are several use cases where you may need a more custom plan. This is where our Enterprise offerings shine.

{% callout %}
In order to prevent fraud, PlanetScale requires a valid payment method in order to create databases on the Hobby (free) tier.
You will not be charged unless you create a Scaler or Scaler Pro database.
{% /callout %}

## PlanetScale Enterprise plan

PlanetScale's Enterprise Plan is great for users that want to scale farther, shard horizontally, and run PlanetScale in a dedicated AWS/GCP account. We offer many different deployment options, all of which come with the same set of standard features. The table below covers those shared features, as well as the different options that vary depending on your chosen deployment.
Expand Down
11 changes: 6 additions & 5 deletions docs/imports/database-imports.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,16 @@ To import an existing database into PlanetScale:

1. Head to your PlanetScale dashboard and click on "**New database**" > "**Import database**", which will bring you to the **Import Setup page**.
2. Give your imported database a name and [select a region](/docs/concepts/regions) from the dropdown.
3. We recommend using the same name as the database you're importing from to avoid having to update any database name references throughout your application code. If you'd prefer to use a different database name, just make sure to update your app where applicable once you fully switch over to PlanetScale.
3. Add a credit card to your organization. You will only be charged if your import requires a Scaler plan and we will ask you to confirm before proceeding.
4. We recommend using the same name as the database you're importing from to avoid having to update any database name references throughout your application code. If you'd prefer to use a different database name, just make sure to update your app where applicable once you fully switch over to PlanetScale.

{% callout %}
Importing a database will **not** count towards your `read` or `write` usage.
{% /callout %}

![Select name and region for new database import](/assets/docs/imports/database-imports/form.png)

4. Fill in the following connection values with information from your existing hosted database:
5. Fill in the following connection values with information from your existing hosted database:

- **Host name** — The address where the database is hosted.
- **Port** — The port where your database is hosted. The default MySQL port is `3306`.
Expand All @@ -41,16 +42,16 @@ To import an existing database into PlanetScale:
database you're importing.
{% /callout %}

5. You'll have the option to **Authenticate with password** or **Authenticate with mTLS**. To authenticate with password, type in the password for the username you entered. Make sure the user has `read` and `write` access to this database.
6. You'll have the option to **Authenticate with password** or **Authenticate with mTLS**. To authenticate with password, type in the password for the username you entered. Make sure the user has `read` and `write` access to this database.

For the "Authenticate with mTLS option", you'll need to provide the following:

- **SSL client certificate** — Certificate to authenticate PlanetScale with your database server.
- **SSL client key** — This is the private key for the client certificate

6. From here you, can proceed to [testing the connection](#test-the-connection) or click "**Show advanced settings**" for more options.
7. From here you, can proceed to [testing the connection](#test-the-connection) or click "**Show advanced settings**" for more options.

7. (Optional) Under Advanced settings, you have the option to enter the following:
8. (Optional) Under Advanced settings, you have the option to enter the following:

- **SSL server name override**
- **SSL CA certificate chain** — If your database server provides a certificate with a non-trusted root CA, please provide the full CA certificate chain here.
Expand Down
3 changes: 2 additions & 1 deletion docs/tutorials/planetscale-quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ Follow these steps to create a database:
2. Name your database using lowercase, alphanumeric characters or underscores. You may also use dashes, but we don't recommend that, as sharded databases require them to be escaped.
3. Select a [region](/docs/concepts/regions). For the lowest latency, select a region near you or your application's hosting location.
4. Select the desired [plan type](/docs/concepts/billing#planetscale-plans) for your database.
5. Finally, click the "**Create database**" button to deploy your database.
5. Enter a valid credit or debit card. If you are creating a database on the **Hobby** plan, you will not be charged.
6. Finally, click the "**Create database**" button to deploy your database.

Your database is created with a [**default production branch**](/docs/concepts/branching), `main`, which you will use to apply a schema change and insert data. While this is just the first branch we create for you, you can always create new development branches (isolated copies of the production schema) off of production to use for development.

Expand Down

0 comments on commit bd79b5f

Please sign in to comment.