Skip to content

Commit

Permalink
working around rebase issue
Browse files Browse the repository at this point in the history
  • Loading branch information
ljsinclair committed Oct 30, 2023
1 parent 8062116 commit 5878d58
Show file tree
Hide file tree
Showing 63 changed files with 589 additions and 399 deletions.
6 changes: 6 additions & 0 deletions _includes/cloud-db/cloud-db-create-custom.md
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) |
2 changes: 2 additions & 0 deletions _includes/cloud-db/cloud-db-custom-note.md
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)
2 changes: 1 addition & 1 deletion _includes/cloud-db/cloud-db-dependencies.md
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)
9 changes: 9 additions & 0 deletions _includes/cloud-db/cloud-db-drop-methods.md
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)-->
8 changes: 0 additions & 8 deletions _includes/cloud-db/cloud-db-metrics-avg-query-resp.md

This file was deleted.

11 changes: 0 additions & 11 deletions _includes/cloud-db/cloud-db-metrics-disk-util.md

This file was deleted.

8 changes: 0 additions & 8 deletions _includes/cloud-db/cloud-db-metrics-ingest-rate.md

This file was deleted.

8 changes: 0 additions & 8 deletions _includes/cloud-db/cloud-db-metrics-qps.md

This file was deleted.

1 change: 1 addition & 0 deletions _includes/cloud-db/cloud-db-serverless-summary.md
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.
15 changes: 15 additions & 0 deletions _includes/cloud-db/cloud-db-shape-benefits.md
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 |
4 changes: 4 additions & 0 deletions _includes/cloud-db/cloud-db-shape-create.md
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"}
6 changes: 6 additions & 0 deletions _includes/cloud-db/cloud-db-shape-limits.md
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.
3 changes: 3 additions & 0 deletions _includes/cloud-db/cloud-db-shape-pricing.md
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"}
6 changes: 6 additions & 0 deletions _includes/cloud-db/cloud-db-shaped-summary.md
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
3 changes: 0 additions & 3 deletions _includes/cloud-db/cloud-db-upgrade-version.md

This file was deleted.

1 change: 1 addition & 0 deletions _includes/cloud-db/cloud-sample-db-summary.md
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.
1 change: 1 addition & 0 deletions _includes/cloud-db/cloud-small-db-summary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The small database is suitable for small databases or development testing.
6 changes: 0 additions & 6 deletions _includes/cloud-db/cloud-summary-db-metrics.md

This file was deleted.

22 changes: 22 additions & 0 deletions _includes/cloud-db/serverless-preview-limitations.md
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
2 changes: 1 addition & 1 deletion _includes/cloud-query/cloud-before-query.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
* [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)
* [Create a table](/docs/cloud/cloud-tables/cloud-table-create)
* [Learn how to import data to FeatureBase](/docs/cloud/cloud-ingest/cloud-ingest-manage)
* [Learn about SQL](/docs/sql-guide/sql-guide-home)
Expand Down
2 changes: 1 addition & 1 deletion _includes/cloud-users/cloud-summary-db-privs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

| Privilege | Applicable role(s) |
|---|---|
| [Create databases](/docs/cloud/cloud-databases/cloud-db-create) | User, Administrator |
| [Create databases](/docs/cloud/cloud-databases/cloud-db-create-custom) | User, Administrator |
| [Read & query databases](/docs/cloud/cloud-query/cloud-query-data) | User, Administrator |
| [Delete databases](/docs/cloud/cloud-databases/cloud-db-delete) | User, Administrator |
2 changes: 1 addition & 1 deletion _includes/cloud/cloud-db-create-before-begin.md
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)
4 changes: 4 additions & 0 deletions _includes/cloud/homepage-db-create-options.md
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**
7 changes: 7 additions & 0 deletions _includes/common/before-begin-database-create.md
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)
1 change: 0 additions & 1 deletion _includes/serverless/serverless-create-defaults.md

This file was deleted.

2 changes: 0 additions & 2 deletions _includes/serverless/serverless-preview-warning.md

This file was deleted.

2 changes: 0 additions & 2 deletions _includes/serverless/serverless-worker-limits.md

This file was deleted.

1 change: 0 additions & 1 deletion _includes/serverless/serverless-worker-shape.md

This file was deleted.

6 changes: 6 additions & 0 deletions _includes/sql-guide/statement-db-alter-create-args.md
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 |
2 changes: 1 addition & 1 deletion docs/cloud/cloud-authentication/cloud-auth-manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Manage API Keys
layout: default
parent: Cloud
has_children: true
nav_order: 5
nav_order: 11
has_toc: false
---

Expand Down
59 changes: 59 additions & 0 deletions docs/cloud/cloud-databases/cloud-db-create-custom.md
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)
23 changes: 14 additions & 9 deletions docs/cloud/cloud-databases/cloud-db-create-sample.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,33 @@ title: Evaluate featurebase at scale
layout: default
parent: Manage databases
grand_parent: Cloud
nav_order: 3
nav_order: 2
---

# How do I quickly evaluate FeatureBase at scale?
{: .no_toc }

This procedure explains how to create a database loaded with sample data you can query immediately.
{% include /cloud-db/cloud-sample-db-summary.md %}

Our sample dataset contains 1 billion customer records with attributes that are commonly used for customer segmentation.
There are two methods to provision the sample database with an approximate duration of 10 minutes.

It will take approximately 10 minutes to create the database.

{: .note }
You can also [create a database of your own](/docs/cloud/cloud-databases/cloud-db-create) then create tables and add data.
{% include /cloud-db/cloud-db-custom-note.md %}

{% include page-toc.md %}

## Before you begin

{: .no_toc }
{% include /cloud/cloud-before-begin.md %}

## Create database with pre-loaded data
## Provision a billion record database

You can create the database in two ways.

### Method one - provision the database with an auto-generated name

{% include /cloud/homepage-db-create-options.md %} under **Start with a billion records**

### Method two - provision the database with a custom name

{% include /cloud-db/cloud-db-new-name.md %}
{% include /cloud-db/cloud-db-load-sample.md %}
Expand Down
69 changes: 0 additions & 69 deletions docs/cloud/cloud-databases/cloud-db-create-serverless.md

This file was deleted.

Loading

0 comments on commit 5878d58

Please sign in to comment.