Skip to content
This repository has been archived by the owner on Nov 12, 2024. It is now read-only.

Commit

Permalink
docs: upstream
Browse files Browse the repository at this point in the history
  • Loading branch information
planetscale-actions-bot committed Mar 6, 2024
1 parent 96810b3 commit 3d5c362
Show file tree
Hide file tree
Showing 31 changed files with 173 additions and 95 deletions.
1 change: 0 additions & 1 deletion docs/concepts/audit-log.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ The organization audit log grants [Organization Administrators](/docs/concepts/a

Audit log retainment period is [based on your plan](/docs/concepts/billing#planetscale-plans):

- **Hobby** — 5 days
- **Scaler Pro** — 15 days
- **Enterprise** — Unlimited

Expand Down
7 changes: 2 additions & 5 deletions docs/concepts/back-up-and-restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@ date: '2022-08-01'
PlanetScale provides the ability to create, schedule, and restore backups for production and development database branches.

{% callout %}
Daily backups of database branches are included free of charge for all databases. Our
[Scaler Pro plan](/docs/concepts/billing#planetscale-plans) includes automated backups every 12
hours.
Our [Scaler Pro plan](/docs/concepts/billing#planetscale-plans) includes automated backups every 12 hours.
{% /callout %}

## View backups
Expand Down Expand Up @@ -65,8 +63,7 @@ You can add additional **scheduled backups** for your branches, billed at $0.023
4. Click the **Save schedule** button to save your new scheduling configurations and to close the pop-up modal.

{% callout %}
For additional scheduled backups beyond the included default (daily for the
[free Hobby plan](/docs/concepts/billing#planetscale-plans) and every 12 hours for the
For additional scheduled backups beyond the included default (every 12 hours for the
[Scaler Pro plan](/docs/concepts/billing#planetscale-plans), you will be billed
**$0.023 per GB per month**.
{% /callout %}
Expand Down
8 changes: 2 additions & 6 deletions docs/concepts/billing.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,11 @@ You'll see a table of current and previous monthly invoices. You can download an

To see more details about your billing from the PlanetScale dashboard, click the "**View details**" button on the Billing page next to the month you want to view. This will show you an overview of the charges for all of the databases in your organization.

{% callout %}
PlanetScale generates both current and past invoices. Even for the **free** plan! You can see the cost had you not been on the Hobby plan.
{% /callout %}

## Payment methods

All plans, including the [free Hobby tier](/docs/concepts/hobby-plan), require your organization has a valid payment method on file. You can use a debit or credit card, but we do not accept pre-paid cards.
All plans require your organization has a valid payment method on file. You can use a debit or credit card, but we do not accept pre-paid cards.

It's possible to use the same card for multiple organizations, but only after the card has been used to successfully pay for a database in the first organization. This is one way that we enforce the limit of one free hobby tier database per individual or company.
It's possible to use the same card for multiple organizations, but only after the card has been used to successfully pay for a database in the first organization.

## Using coupons

Expand Down
10 changes: 8 additions & 2 deletions docs/concepts/database-sleeping.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
---
title: 'Database Sleeping'
subtitle: 'Learn when database sleeping takes effect and how to wake up a sleeping database.'
date: '2023-07-26'
date: '2023-03-06'
---

## Overview

{% callout %}
The Hobby plan will be deprecated on April 8th, 2024. You will no longer be able to create new Hobby databases as of March 6th, 2024. Any Hobby databases that have not been migrated by April 8th, 2024 will be slept. Read the [Hobby plan deprecation FAQ documentation](/docs/concepts/hobby-plan-deprecation-faq) more information about next steps.

If you are currently on the Hobby plan and you need to migrate your data, but your database has been slept, you can wake your database one time to export your data. Follow the instructions in the [Hobby plan deprecation FAQ](/docs/concepts/hobby-plan-deprecation-faq) to dump your data.
{% /callout %}

After a period of inactivity, free databases will enter 'sleep' mode. All data will be backed up and stored, but you will not be able to connect to the database.

{% callout %}
If you have a Hobby database that has been slept and cannot be woken up due to not having a valid payment method or the plan being no longer offered in your location, please [reach out to our Support team](https://support.planetscale.com/). They will wake your database for a short period of time so you can dump your data, if needed.
If you have a Hobby database that has been slept and cannot be woken up due to not having a valid payment method, please [reach out to our Support team](https://support.planetscale.com/). They will wake your database for a short period of time so you can dump your data, if needed.
{% /callout %}

## What is database sleeping
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/deployment-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Your deployment options depend on the [PlanetScale plan](/docs/concepts/planetsc

## Multi-tenancy deployment on PlanetScale

Multi-tenancy is the default deployment option. When you sign up for a PlanetScale account, whether on a Hobby or Scaler Pro plan, your databases will be created in our multi-tenancy deployment offering. Our Enterprise plan also offers a multi-tenancy deployment option.
Multi-tenancy is the default deployment option. When you sign up for a PlanetScale account with a Scaler Pro plan, your databases will be created in our multi-tenancy deployment offering. Our Enterprise plan also offers a multi-tenancy deployment option.

### Multi-tenancy highlights

Expand Down
96 changes: 96 additions & 0 deletions docs/concepts/hobby-plan-deprecation-faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
---
title: 'Hobby tier deprecation - FAQ'
subtitle: 'Frequently asked questions about the removal of the Hobby tier.'
date: '2024-03-06'
---

## Overview

PlanetScale is removing our Hobby tier. [Please read our blog post here to learn more](/blog/planetscale-forever).

All existing Hobby tier databases will need to upgrade their database to a paid plan by April 8, 2024. Databases which are not upgraded by April 8th will be shutdown and no longer accessible. Data will not be deleted, but a paid plan will be required to access data after April 8th.

- [What is happening to the Hobby Tier?](#what-is-happening-to-the-hobby-tier-)
- [How do I stop my database from being slept?](#how-do-i-stop-my-database-from-going-offline-)
- [Will PlanetScale delete my data?](#will-planetscale-delete-my-data-)
- [How do I migrate off of PlanetScale?](#how-do-i-migrate-off-of-planetscale-)
- [How do I get my data after April 8th?](#how-do-i-get-my-data-after-april-8th-)
- [I can't migrate in time, help!](#i-can-t-migrate-in-time-help)

## What is happening to the Hobby tier?

PlanetScale has made the decision to stop offering our Hobby tier.

On March 6th, it will no longer be possible to create new Hobby tier databases. Databases which are not upgraded by April 8th will be shutdown and no longer accessible. Data will not be deleted, but a paid plan will be required to access data after April 8th.

## How do I stop my database from going offline?

To prevent your database from going offline on April 8th, you need to upgrade to a paid plan.

## Will PlanetScale delete my data?

No! PlanetScale's [database sleeping](/docs/concepts/database-sleeping) makes a backup copy of your data before shutting a database down and safely archives it. If you would like to access this data in the future, you will need to upgrade your database to a paid plan.

## How do I migrate off of PlanetScale?

First, export the data from your branch using the [PlanetScale CLI](/docs/concepts/planetscale-environment-setup):

```bash
pscale db dump <DATABASE_NAME> <BRANCH_NAME>
```

This may take several minutes, depending on the amount of data in the branch. The dump of your data will be in a folder in your working directory. For example:

```bash
pscale database dump test main
```

You'll see a message like this:

```
Starting to dump all tables from database test to folder /Users/nick/pscale_dump_test_main_20240305_144231
Dumping is finished! (elapsed time: 3.886106333s)
```

Inside of the `pscale_dump_test_main_20240305_144231` folder, there is a `test.test-schema.sql` file which contains the schema for the database, as well as one or more files with names like `test.test.00001.sql` which contain the data.

PlanetScale's CLI uses a format compatible with [`https://github.com/mydumper/mydumper`](https://github.com/mydumper/mydumper), which can be used to load the data into another instance of MySQL. Using a MySQL instance hosted on DigitalOcean as an example:

```bash
cat db.ini
[myloader]
host = db-mysql-sfo3-5233-do-user-137498-0.b.db.ondigitalocean.com
user = doadmin
password = <REDACTED>
database = defaultdb
port = 25060
```

Then, we can run `go-mydumper` to load data into the other MySQL instance:

```bash
myloader --defaults-file db.ini --directory pscale_dump_test_main_20240305_144231/
```

If you get an error that looks like:

```sql
Unknown column 'nick2' in 'field list'
```

Ensure that your `SQL_MODE` does not contain `ANSI_QUOTES`.

Once this is done, your data should be loaded in your other MySQL database.

If you run into any issues, please don't hesitate to reach out to `[email protected]` or submit a ticket at [`https://support.planetscale.com`](https://support.planetscale.com).

## How do I get my data after April 8th?

To connect to your data and access it after April 8th, you will need to upgrade to a paid plan, such as Scaler Pro. You will not be billed until it is fully awake.

We do not want to hold your data hostage. If your database has been slept and you don't want to upgrade to a paid plan or cannot afford it, please write into `[email protected]`. We will happily bring your database back online for 24 hours so that you can export your data using the [migration path](#how-do-i-migrate-off-of-planetscale) we have outlined in this document.

## I can't migrate in time, help!

If this causes you or your business problems, please don't hesitate to reach out to `support@planetscale` or submit a ticket at [`https://support.planetscale.com`](https://support.planetscale.com). We are happy
to work with you to minimize the disruption that this change causes.
15 changes: 11 additions & 4 deletions docs/concepts/hobby-plan.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,32 @@
---
title: 'PlanetScale Hobby plan'
subtitle: 'Learn about the free usage-based Hobby plan'
date: '2024-02-21'
date: '2024-03-06'
---

## Overview

The Hobby plan is our free tier database that can be used to test PlanetScale. It comes with 5GB of storage and includes 1 billion row reads/mo, 10 million row writes/mo, one production branch, and one development branch.
{% callout %}
The Hobby plan will be deprecated on April 8th, 2024, and you are no longer able to create new Hobby databases as of March 6th, 2024.

Any Hobby databases that have not been migrated by April 8th, 2024 will be slept. Data will not be deleted, but a paid plan will be required to access data after April 8th. Read the [Hobby plan deprecation FAQ documentation](/docs/concepts/hobby-plan-deprecation-faq) more information about next steps.
{% /callout %}

Although the Hobby plan has now been deprecated, this documentation will remain live as reference for existing Hobby databases until the final sunset date &mdash; April 8th, 2024.

The Hobby plan was our free tier database that could be used to test PlanetScale. It came with 5GB of storage and includes 1 billion row reads/mo, 10 million row writes/mo, one production branch, and one development branch.

Hobby database clusters live in 1 availability zone, and production branches include one primary and one replica by default.

Some important limitations of the Hobby plan to be aware of:

- The Hobby plan plan is not available in all locations.
- In order to prevent fraud, PlanetScale requires a [valid payment method](/docs/billing/payment-method) to create databases on the Hobby tier. You will not be billed unless you create a Scaler Pro database, but you may see a [**temporary** $1 authorization charge](https://support.stripe.com/questions/unexpected-1-charge-on-customers-bank-statement) on your card for verification.
- If you do not add a valid payment method to existing organizations with a Hobby database, your database may be [slept](/docs/concepts/database-sleeping) at any time.
- You are limited to **one free database per organization**.
- Free databases may be [slept](/docs/concepts/database-sleeping) after a 7-day period of inactivity.

{% callout %}
If you have a Hobby database that has been slept and cannot be woken up due to not having a valid payment method or the plan being no longer offered in your location, please [reach out to our Support team](https://support.planetscale.com/). They will wake your database for a short period of time so you can dump your data, if needed.
If you have a Hobby database that has been slept and cannot be woken up due to not having a valid payment method, please [reach out to our Support team](https://support.planetscale.com/). They will wake your database for a short period of time so you can dump your data, if needed.
{% /callout %}

The following table shows everything that is included on the Hobby plan:
Expand Down
30 changes: 11 additions & 19 deletions docs/concepts/planetscale-plans.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,24 @@
---
title: 'PlanetScale plans'
subtitle: 'Learn about the different products and plans we offer: Hobby, Scaler Pro, and Enterprise'
date: '2024-02-21'
subtitle: 'Learn about the different products and plans we offer: Scaler Pro and Enterprise'
date: '2024-03-06'
---

## Overview

PlanetScale is built to accomodate all companies at all stages. Whether you need a hassle-free managed database for your side project or you’re running millions of queries per second at the scale of YouTube, we have a solution for you.

Our plans are split into two general offerings: [Self-serve](#self-serve-plans) and [Enterprise](#planetscale-enterprise-plan).

## Self-serve plans

Self-serve is comprised of two plans that you can sign up for from the PlanetScale dashboard. The free tier, **Hobby**, is usage-based. **Scaler Pro**, our paid tier starting at $39/mo, is resource-based and priced on the infrastructure provisioned to support your specific workload.

To learn about the free Hobby plan, see our [Hobby plan documentation](/docs/concepts/hobby-plan).
Our plans are split into two general offerings: [Scaler Pro (self-serve)](#self-serve-plans) and [Enterprise](#planetscale-enterprise-plan).

{% callout %}
We previously offered a usage-based plan, Scaler, which has now been deprecated. You can no longer create new databases on the Scaler plan, and existing Scaler database have until April 8th to upgrade. This document includes information about the Scaler plan as reference for those still on Scaler during this migration period.
We previously offered a free tier plan &mdash; [Hobby](/docs/concepts/hobby-plan). The Hobby plan will be deprecated on April 8th, 2024, and you are no longer able to create new Hobby databases as of March 6th, 2024.

Any Hobby databases that have not been migrated by April 8th, 2024 will be slept. Read the [Hobby plan deprecation FAQ documentation](/docs/concepts/hobby-plan-deprecation-faq) more information about next steps.
{% /callout %}

### Resource-based plan &mdash; Scaler Pro
## Scaler Pro

The **Scaler Pro** plan is broken down by cluster size, which have varying levels of compute power depending on the needs of your database.
The **Scaler Pro** plan is broken down by cluster size, which have varying levels of compute power depending on the needs of your database. As your application scales, upgrading or downgrading your **Scaler Pro** cluster is a seamless operation that does not involve any downtime.

| | **Processor** | **Memory** |
| ---------- | ------------- | ---------- |
Expand Down Expand Up @@ -108,7 +104,7 @@ If you find the performance of a given query to be substantially inconsistent ov

We previously offered a usage-based paid plan, Scaler, which [is now deprecated](/blog/deprecating-the-scaler-plan). You can no longer create new Scaler database clusters. We recommend starting on Scaler Pro for paid plans. Please see our [Scaler Pro upgrade documentation](/docs/concepts/scaler-pro-upgrade-faq) for upgrading an existing Scaler database to Scaler Pro.

The following table is for reference only and covers what was included on our Scaler plan:
The following table is for reference only and covers what was included on our Scaler plan for those still in the migration process:

| | **Scaler** |
| ---------------------------------------------------------------------------- | ---------------------- |
Expand Down Expand Up @@ -138,13 +134,9 @@ The following table is for reference only and covers what was included on our Sc
- Extra rows read over the included amount are billed at $1 per additional 1 billion
- Extra rows written over the included amount are billed at $1.50 per additional 1 million.

## Selecting a self-serve plan

Selecting the correct plan for your database can have a dramatic impact on how it performs, and how much it costs. The plans are designed to grow with you. For example:
### Selecting a cluster size

- If you are starting a new project or simply experimenting with PlanetScale, the [free **Hobby** plan](/docs/concepts/hobby-plan) is perfectly suited for you.
- Once your application's usage starts to grow, migrating to **Scaler Pro** will provide consistent performance and pricing.
- As your application scales, upgrading your **Scaler Pro** cluster to boost the performance of your database is a seamless operation that does not involve any downtime.
Selecting the correct cluster size for your database can have a dramatic impact on how it performs, and how much it costs.

If you are migrating from an existing cloud provider with resource-based pricing, be sure to compare your currently selected instance with our available **Scaler Pro** cluster sizes. Databases in PlanetScale often come with additional beneficial infrastructure that is not easily configured or available in other hosted database solutions. For more information on what is provisioned with each database, read our [Architecture](/docs/concepts/architecture) doc.

Expand Down
7 changes: 1 addition & 6 deletions docs/concepts/query-insights.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,6 @@ The dropdown on the top right lets you select which branch you want to analyze.

You can click the dates listed above the graph to scroll through the past seven days. To further narrow down query analysis, you can select a time range by clicking on the graph and dragging the cursor across. This will zoom in on the selected timeframe.

{% callout %}
On the free Hobby plan, query insights are limited to the previous 24 hours. To unlock the full seven days of
analytics, [upgrade to a paid plan](/docs/concepts/billing).
{% /callout %}

You also have the option to save a screenshot of the graph by clicking "Save".

If any deploy requests were deployed during the selected period, you will also see an overlay with a link to the deploy request. This can help you quickly assess any impact a deploy request had on your database.
Expand Down Expand Up @@ -107,7 +102,7 @@ You can customize the metrics that show up on the Queries list by clicking the "
- **`p50` latency** &mdash; The `p50` latency for the query in milliseconds. This means that 50% of requests completed faster than the time listed.
- **`p99` latency** &mdash; The `p99` latency for the query in milliseconds. This means that 99% of requests completed faster than the time listed.
- **Rows returned** &mdash; The total number of rows fetched by a `SELECT` statement. This includes all times the query has run in the displayed time frame.
- **Rows read** &mdash; The total number of rows read. This includes all times the query has run in the displayed time frame. This is the number that directly affects your [rows read billing calculation](/docs/concepts/hobby-plan#understanding-rows-read).
- **Rows read** &mdash; The total number of rows read. This includes all times the query has run in the displayed time frame.
- **Rows read/rows returned** &mdash; The result of dividing total rows read by rows returned in a query. A high number can indicate that your database is reading unnecessary rows, and they query may be improved by adding an index.
- **Rows affected** &mdash; The total number of rows modified by an `INSERT`, `UPDATE`, or `DELETE` statement. This includes all times the query has run in the displayed time frame.
- **Last run** &mdash; The last time a query was run.
Expand Down
Loading

0 comments on commit 3d5c362

Please sign in to comment.