generated from just-the-docs/just-the-docs-template
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8062116
commit 5878d58
Showing
63 changed files
with
589 additions
and
399 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
FeatureBase provides two types of database: | ||
|
||
| Category | Description | Additional information | | ||
|---|---|---| | ||
| Shaped | A database with fixed resources | [Shaped databases](/docs/cloud/cloud-databases/cloud-db-shaped) | | ||
| Serverless | A database with scalable resources | [Serverless databases](/docs/cloud/cloud-databases/cloud-db-serverless) | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
{: .note} | ||
You can create any size database using the [Custom database option](/docs/cloud/cloud-databases/cloud-db-manage/#create-a-custom-database) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
* [Learn how to create a database](/docs/cloud/cloud-databases/cloud-db-create) | ||
* [Learn how to create a database](/docs/cloud/cloud-databases/cloud-db-create-custom) | ||
* [Learn how to create tables](/docs/cloud/cloud-tables/cloud-table-manage) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
## How do I drop my database? | ||
|
||
There are two ways to drop (delete) FeatureBase Cloud databases | ||
|
||
* [Delete database using Cloud GUI](/docs/cloud/cloud-databases/cloud-db-delete) | ||
* [Delete database using Cloud API](https://api-docs-featurebase-cloud.redoc.ly/latest#operation/deleteDatabase){:target="_blank"} | ||
|
||
<!-- commented out because this statement not supported as of October 2023 | ||
* [DROP Database statement](/docs/sql-guide/statements/statement db-drop)--> |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
FeatureBase **Serverless** databases allow you to scale your database RAM and CPU resources when required and without needing to spin the database down. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
## What are the benefits of a shaped database? | ||
|
||
In general, shaped databases have: | ||
* overprovisioned disk space and memory to ensure best performance | ||
* data replication should a node go down. | ||
|
||
### Predefined resources | ||
|
||
CPU and memory resources are bundled for easier billing. Choose an appropriate shape for your requirements: | ||
|
||
| Resource | Minimum | Maximum | | ||
|---|---| | ||
| Memory | 32GB | 2TB | | ||
| Disk storage | 100GB | 2TB | | ||
| Virtual CPU | 12 | 576 | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
## How do I create a shaped database? | ||
|
||
* [Create a Shaped Database in the Cloud UI](/docs/cloud/cloud-databases/cloud-db-create-custom) | ||
* [Create a Shaped Database using the Cloud API](https://api-docs-featurebase-cloud.redoc.ly/latest/#tag/Databases){:target="_blank"} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
## What are the limitations of a shaped database? | ||
|
||
A shaped database cannot be resized once created. Data must be migrated to a new database. | ||
|
||
{: .note} | ||
[FeatureBase Serverless databases](/docs/cloud/cloud-databases/cloud-db-serverless) can be resized as required. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
## How are shaped databases priced? | ||
|
||
* [FeatureBase Shaped database pricing](https://www.featurebase.com/pricing){:target="_blank"} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
A Shaped database provides a number of benefits, the most important of which is predictable pricing. | ||
|
||
Database shapes define: | ||
* How much memory is available | ||
* how much disk space is available | ||
* how many vCPUs) are available |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
The FeatureBase sample database contains one billion customer records with attributes that are commonly used for customer segmentation. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
The small database is suitable for small databases or development testing. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
### SQL limitations | ||
|
||
| Limitation | Supported? | Additional information | | ||
|---|---|---| | ||
| [SELECT...GROUP BY clause](/docs/sql-guide/statements/statement-select/#group-by-clause) | Not supported for IDSET or STRINGSET data types | * [IDSET() data type](/docs/sql-guide/data-types/data-type-idset)<br/>* [STRINGSET() data type](/docs/sql-guide/data-types/data-type-stringset) | | ||
| [SELECT...HAVING clause](/docs/sql-guide/statements/statement-select/#having-clause) | Not supported | | | ||
| [SELECT...TOP clause](/docs/sql-guide/statements/statement-select/#top-clause) | Not supported | | | ||
| [SELECT...LIMIT clause]() | Not supported | LIMIT can be used with `FROM` and `GROUP BY` clauses | | ||
| [IDSETQ() data type](/docs/sql-guide/data-types/data-type-idsetq) | Not supported | | ||
| [STRINGSETQ() data type](/docs/sql-guide/data-types/data-type-stringsetq) | Not supported | | ||
|
||
### PQL limitations | ||
|
||
| Limitation | Supported? | | ||
|---|---| | ||
| [PQL Percentile](/docs/pql-guide/pql-read-percentile) | Not supported | | ||
|
||
### Database backup and recovery limitations | ||
|
||
Serverless databases do not support: | ||
* Database snapshotting | ||
* Database restore from backup |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
* [Create a database using the Cloud UI](/docs/cloud/cloud-databases/cloud-db-create), OR | ||
* [Create a database using the Cloud UI](/docs/cloud/cloud-databases/cloud-db-create-custom), OR | ||
* [Create a database using the Cloud API](https://api-docs-featurebase-cloud.redoc.ly/latest/#operation/createDatabase) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{: .note} | ||
This method is available only when you have no existing database | ||
|
||
* Click **Home** then **CREATE** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
Create a FeatureBase database using one of the following methods: | ||
* [Create database using Cloud GUI](/docs/cloud/cloud-databases/cloud-db-manage) | ||
* [Create database using Cloud API](https://api-docs-featurebase-cloud.redoc.ly/latest/#operation/createDatabase){:target="_blank"} | ||
<!--* [CREATE DATABASE statement](/docs/sql-guide/statements/statement-db-create)--> | ||
|
||
{: .note} | ||
A database is automatically created when you [Install FeatureBase Community](/docs/community/com-home) |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
## Arguments | ||
|
||
| Argument | Description | Required | Default | Additional information | | ||
|---|---|---|---|---| | ||
| `database-name` | Name of database | Yes | | Database names cannot be altered | | ||
| `WITH WORKERS <int-val>` | Add an integer value for each worker which represents 2GB of memory and 1x vCPU | Yes | 1 | 0 to 8 workers can be set with a maximum of 16GB of memory and 8vCPU | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
--- | ||
title: Create custom database | ||
layout: default | ||
parent: Manage databases | ||
grand_parent: Cloud | ||
nav_order: 3 | ||
--- | ||
|
||
# How do I create a custom database? | ||
{: .no_toc } | ||
|
||
There are three ways to provision a database with a custom configuration in FeatureBase Cloud. | ||
|
||
## Before you begin | ||
|
||
{% include /cloud/cloud-before-begin.md %} | ||
* [Learn how to manage databases](/docs/cloud/cloud-databases/cloud-db-manage) | ||
|
||
## What types of custom database are available? | ||
|
||
{% include /cloud-db/cloud-db-create-custom.md %} | ||
|
||
## Naming standards | ||
|
||
{% include /concepts/standard-naming-obj.md %} | ||
{% include /cloud-db/cloud-standard-naming-db.md %} | ||
|
||
## How do I provision a database with a custom configuration? | ||
|
||
There are three methods to provision a custom configured database. | ||
|
||
### Method one - provision database from the homepage | ||
|
||
{% include /cloud/homepage-db-create-options.md %} under **Make something custom**. | ||
|
||
### Method two - provision database via the Databases page | ||
|
||
{% include /cloud-db/cloud-db-new-name.md %} | ||
|
||
Choose from the **Memory** drop-down: | ||
|
||
* Serverless (Preview) 2GB Worker, or | ||
|
||
{% include /cloud-db/cloud-db-total-shapes.md %} | ||
|
||
{% include /cloud-db/cloud-db-click-create.md %} | ||
|
||
## Method 3 - provision the database using Cloud API | ||
|
||
* [Create a database using Cloud API](https://api-docs-featurebase-cloud.redoc.ly/latest#operation/createDatabase){:target="_blank"} | ||
|
||
## Next step | ||
|
||
* [Learn how to create tables](/docs/cloud/cloud-tables/cloud-table-create) | ||
|
||
## Further information | ||
|
||
* [Create database API reference](https://api-docs-featurebase-cloud.redoc.ly/latest#operation/createDatabase) | ||
* [Learn how to delete a database](/docs/cloud/cloud-databases/cloud-db-delete) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.