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.

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

docs(SDB): add new terms to concept page MTA-3562 #2047

Merged
merged 7 commits into from
Aug 21, 2023
Merged
Changes from 6 commits
Commits
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
83 changes: 78 additions & 5 deletions serverless/sql-databases/concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ categories:
---

<Concept opened>
## Serverless SQL Database
## Active state

Scaleway Serverless SQL Databases are fully managed databases that automatically scale both in storage and compute according to your workloads.
A database is in an active state when it receives queries frequently (at least once every 5 minutes). If it receives no query for 5 minutes, the database switches to an idle state, and the billing for compute capacity will stop.
SamyOubouaziz marked this conversation as resolved.
Show resolved Hide resolved
</Concept>

<Concept opened>
Expand All @@ -23,7 +23,80 @@ categories:
</Concept>

<Concept opened>
## Credentials
## Backup

Credentials let you connect to your database via a secret key.
</Concept>
A database backup is a copy of the data stored in the database (including data structure, such as tables). Database backups in Serverless SQL Database are logical backups (as opposed to raw disk volume backups, also called "snapshots"). Database backups can be restored in the current database or any other PostgreSQL database and allows to recover from database crash, data corruption, or data loss.
</Concept>

<Concept opened>
## Cold start

Cold start is the time an idle database takes to handle the first request. It usually takes less than five seconds.
SamyOubouaziz marked this conversation as resolved.
Show resolved Hide resolved
</Concept>

<Concept>
## Connection pooling

Connection pooling is the process of mutualizing client connections used to connect to the database. By default, connections to PostgreSQL databases uses a lot of memory, which can have a significant impact on performance when hundreds of clients are connected to a database at the same time. With connection pooling, a common component (a "connection pooler", such as PgBouncer) connects to the database and maintains multiple connections to it. Clients then connect to the connection pooler instead of connecting directly to the database, allowing for better performance and more concurrent connections.
SamyOubouaziz marked this conversation as resolved.
Show resolved Hide resolved
</Concept>

<Concept>
## Credentials

Credentials are the login and password (also called "username" and "password" in PostgreSQL vocabulary) used by a user or an application to connect to a database. With Scaleway Serverless SQL Databases, logins are IAM principal IDs and passwords are IAM secret keys.
SamyOubouaziz marked this conversation as resolved.
Show resolved Hide resolved
</Concept>

<Concept>
## Engine
SamyOubouaziz marked this conversation as resolved.
Show resolved Hide resolved

A database engine is the software that stores and retrieves your data from a database. Serverless SQL databases use the PostgreSQL engine.
</Concept>

<Concept>
## High availability

Databases can become unavailable due to several issues (host crashes, disk corruption, network unavailability, etc.). High Availability allows to ensure that databases stay available most of the time and recover quickly from issues so that applications relying on them remain available as well.
SamyOubouaziz marked this conversation as resolved.
Show resolved Hide resolved
</Concept>

<Concept>
## Idle

A database switches to an idle state if it receives no query for 5 minutes. You are not billed for compute resources while your database is in an idle state.
</Concept>

<Concept>
## Logs

Logs register the activity of your database. They provide useful information for debugging or to know more about the behavior and activity of your databases.
</Concept>

<Concept>
## PostgreSQL

PostgreSQL is an open source object-relational database system known for its reliability, robustness, and performance.
</Concept>

<Concept>
## Region and AZ

<Macro id="region-and-az" />

SamyOubouaziz marked this conversation as resolved.
Show resolved Hide resolved
</Concept>

<Concept>
## Relational database

A database type that relies on the relational model and that can be queried using the SQL language. In the relational model, different data objects are stored in different tables, which can be linked by common IDs, or keys. Relational databases provide an intuitive, straightforward way of representing data in tables, which favors data normalization and provide the strongest data consistency guarantees (compared to NoSQL alternatives).
SamyOubouaziz marked this conversation as resolved.
Show resolved Hide resolved
</Concept>

<Concept>
## Serverless database

A serverless database is a fully managed database-as-a-service (DBaaS) that allocates and scales compute and storage resources automatically to match the incoming workload.
</Concept>

<Concept>
## Status

The status of a database changes according to its activity and provides information on ongoing operations.
</Concept>