Skip to content

Commit

Permalink
Cloud table fixes (#210)
Browse files Browse the repository at this point in the history
What happened here?
* small fixes to cloud tables to standardize the step numbers
* shifted upload data to ingest because it falls under that heading
* removed sales&marketing/dev information from ingest page because it's
not relevant to the user (i.e., they already knew what was in the
original file, but really didn't need to know the level of detail
* small updates to SQL pages to get them in sync and in the right order
  • Loading branch information
ljsinclair authored Dec 1, 2023
1 parent b1cc078 commit 2a81d46
Show file tree
Hide file tree
Showing 32 changed files with 105 additions and 125 deletions.
2 changes: 1 addition & 1 deletion _includes/cloud-users/cloud-summary-table-privs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
|---|---|
| [Create tables](/docs/cloud/cloud-tables/cloud-table-create) | User, Administrator |
| [Read & query tables](/docs/cloud/cloud-query/cloud-query-data) | User, Administrator |
| [Upload Data](/docs/cloud/cloud-tables/cloud-table-upload-data) | User, Administrator|
| [Upload Data](/docs/cloud/cloud-ingest/cloud-table-upload-data) | User, Administrator|
| [Add table column](/docs/cloud/cloud-tables/cloud-table-add-column) | User, Administrator|
| [Delete table column](/docs/cloud/cloud-tables/cloud-table-delete-column) | User, Administrator|
| [Delete tables](/docs/cloud/cloud-tables/cloud-table-delete) | User, Administrator |
1 change: 1 addition & 0 deletions docs/cloud/cloud-configuration/configuration-billing.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Account usage is provided on the **Configuration** page and includes:
You can upgrade to a Paid account using a US account number or credit card via the Stripe billing system.

* Click **Configuration** > **Upgrade to Paid**.
* Complete the forms as directed.

## Further information

Expand Down
26 changes: 5 additions & 21 deletions docs/cloud/cloud-ingest/cloud-ingest-manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,31 +3,15 @@ title: Manage cloud ingestion
layout: default
parent: Cloud
has_children: false
nav_order: 7
nav_order: 8
has_toc: false
---

# How do I import data to my FeatureBase Cloud database?
{: .no_toc }

{% include page-toc.md %}
There are several ways to import data to an existing table in your database:

## Before you begin

{% include /cloud-db/cloud-db-dependencies.md %}

## Load data into your database

All data ingestion is performed using SQL. The product puts an emphasis on push-based, streaming models in which you, the client, create a process to push data to your databases with SQL statements. This model allows you to control how data is pushed and what(if any) processes run to transform or clean the data before ingestion. This model also keeps data in your datacenter should upstream issues arise. Lastly, push-based ingest helps protect your datacenter by keeping it closed to outside connections that reach in and pull data. Today, the tool only supports SQL through HTTPS. Any process or application that can make calls over HTTPS is able to push data to FeatureBase.

Once data is pushed, it is translated into FeatureBases’s format and writes the data into your table. This process typically reduces your data’s footprint by 10x but can see reductions upwards of 100x.

## Data Model

Data modeling determines how data is imported to FeatureBase and how it is represented to meet your needs.

* [Learn about data modeling](/docs/concepts/overview-data-modeling)

## Next step

* [Learn how to ingest data](/docs/sql-guide/statements/statement-insert-bulk)
* [Upload data from a CSV file in the UI](/docs/cloud/cloud-ingest/cloud-table-upload-data)
* [SQL INSERT statement](/docs/sql-guide/statements/statement-insert)
* [SQL BULK INSERT statement](/docs/sql-guide/statements/statement-insert-bulk)
Original file line number Diff line number Diff line change
@@ -1,65 +1,65 @@
---
title: Upload data
layout: default
parent: Manage tables
parent: Upload data
grand_parent: Cloud
nav_order: 2
---

# How do I upload data to FeatureBase Cloud?
{: .no_toc }

You can upload data to FeatureBase cloud using a specifically structured CSV file.
Upload data from a CSV file to a new destination table.

{: .note}
You can also upload data using the [BULK INSERT statement](/docs/sql-guide/statements/statement-insert-bulk)
You can also upload CSV data using the [BULK INSERT statement](/docs/sql-guide/statements/statement-insert-bulk)

## Before you begin

{% include /cloud/cloud-before-begin.md %}
* [Create a database](/docs/cloud/cloud-databases/cloud-db-create-custom)
* Click **Databases** > database name > **Upload Data**.

## Naming standards

{% include /concepts/standard-naming-obj.md%}
{% include /cloud-table/cloud-standard-naming-table.md %}

## Upload file
## CSV file structure

Your CSV data file needs the following structure:

* Header row
* First item in the header row and each row is a unique identifier
* Each row of data is comma-separated
* Optional header row
* First column is a unique identifier
* Each item of data is separated by commas
* New line is a new row

## Uploading data to a table

{: .important}
Table column names cannot be changed once the table is defined.

### Step 1: Navigate to Upload Data

* Click **Databases** > database name > **Upload Data**.

### Step 2: Select a file to upload
### Step 1: Select a file to upload

1. Click **Upload a file**.
2. Select a file from the file browser.
3. Click **Done**.
* Click **Upload a file**.
* Select the CSV file from the browser.
* Click **The first row contains column labels** if your CSV contains a header row.
* Click **Done**.

### Step 3: Select column type for each column
### Step 2: Select column data types

{% include /cloud-table/cloud-summary-table-pk.md %}

1. Click <span class="material-icons md-18">more_vert</span> on the column.
2. Click **Update**.
3. Select a type from the **Type** dropdown menu.
4. Click **Update Column**.
* Click <span class="material-icons md-18">more_vert</span> on the column.
* Click **Update**.
* Select a type from the **Type** dropdown menu.
* Set a constraint if required.
* Click **Update Column**.

{: .note }
User cannot procced until all column types have been selected.
User cannot procced until all column data types have been selected.

### Step 4: Name the table and write data
### Step 3: Name your table and write data

{: .note}
>You can download SQL statements automatically generated by FeatureBase if required:
Expand Down
17 changes: 7 additions & 10 deletions docs/cloud/cloud-tables/cloud-table-add-column.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ nav_order: 3
{% include /cloud/cloud-before-begin.md %}
* [Create a database](/docs/cloud/cloud-databases/cloud-db-create-custom)
* [Create a table](/docs/cloud/cloud-tables/cloud-table-create)
* * Click **Databases** > database name > **Tables** to view tables.

## Column data types and constraints

Expand All @@ -26,20 +27,16 @@ nav_order: 3
{% include /concepts/standard-naming-obj.md%}
{% include /cloud-table/cloud-standard-naming-col.md %}

## Step 1: View all tables

{% include /cloud-table/cloud-table-view-list.md %}

## Step 2: Add a column to a table
## Add a column to a table

{: .note }
Table columns cannot be edited once created.

1. Click the table name.
2. Click **Columns** > **Add column**.
3. Enter a name for the column
4. Choose the data type and enter values for the constraints if available.
5. Click **Add column**
* Click the table name.
* Click **Columns** > **Add column**.
* Enter a name for the column
* Choose the data type and enter values for the constraints if available.
* Click **Add column**

## Further information

Expand Down
19 changes: 8 additions & 11 deletions docs/cloud/cloud-tables/cloud-table-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,28 +21,25 @@ You can also create a table using a [SQL CREATE TABLE statement](/docs/sql-guide
{% include /cloud/cloud-before-begin.md %}
* [Learn how to create a database](/docs/cloud/cloud-databases/cloud-db-create-custom)
* [Learn how to manage tables](/docs/cloud/cloud-tables/cloud-table-manage)
* Click **Databases** > database name > **Tables** to view tables.

## Naming standards

{% include /concepts/standard-naming-obj.md%}
{% include /cloud-table/cloud-standard-naming-table.md %}

## Step 1: view tables
## Step 1: create table

{% include /cloud-table/cloud-table-view-list.md %}
* Click **Create table**.
* Select the destination database.
* Enter a table name and an optional description.

## Step 2: create table

1. Click **Create table**.
2. Select the destination database.
3. Enter a table name and an optional description.

## Step 3: choose the primary key
## Step 2: choose the primary key

{% include /cloud-table/cloud-summary-table-pk.md %}

1. Select the ID type.
2. Click **Create**.
* Select the ID type.
* Click **Create**.

## Next step

Expand Down
17 changes: 7 additions & 10 deletions docs/cloud/cloud-tables/cloud-table-delete-column.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,15 @@ You may need to delete a column if:
* [Learn how to create a database](/docs/cloud/cloud-databases/cloud-db-manage)
* [Create a table](/docs/cloud/cloud-tables/cloud-table-create)
* [Create a table column](/docs/cloud/cloud-tables/cloud-table-add-column)
* Click **Databases** > database name > **Tables** to view tables.

## Step 1: View all tables
## Drop the selected column

{% include /cloud-table/cloud-table-view-list.md %}

## Step 2: Drop the selected column

1. Click the table name.
2. Click **Columns**.
3. Click <span class="material-icons md-18">more_vert</span> on the column > **Delete**.
5. Enter "DELETE" in the confirmation dialog.
6. Click **Delete**.
* Click the table name.
* Click **Columns**.
* Click <span class="material-icons md-18">more_vert</span> on the column > **Delete**.
* Enter "DELETE" in the confirmation dialog.
* Click **Delete**.

## Further information

Expand Down
18 changes: 7 additions & 11 deletions docs/cloud/cloud-tables/cloud-table-delete.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Drop table
title: Delete table
layout: default
parent: Manage tables
grand_parent: Cloud
nav_order: 6
---

# How do I drop a table in FeatureBase Cloud?
# How do I delete a table in FeatureBase Cloud?
{: .no_toc }

There are a number of reasons why you may choose to drop a table, including:
Expand All @@ -27,18 +27,14 @@ There are a number of reasons why you may choose to drop a table, including:
{% include /cloud/cloud-before-begin.md %}
* [Create a database](/docs/cloud/cloud-databases/cloud-db-create-custom)
* [Create a table](/docs/cloud/cloud-tables/cloud-table-create)
* Click **Databases** > database name > **Tables** to view tables.

## Step 1: View table list
## Delete the selected table

{% include /cloud-table/cloud-table-view-list.md %}

## Step 2: Drop the selected table

1. Click <span class="material-icons md-18">more_vert</span> > **Drop table**
2. Enter "DELETE" in the confirmation dialog.
3. Click **Drop table**.
* Click <span class="material-icons md-18">more_vert</span> > **Drop table**
* Enter "DELETE" in the confirmation dialog.
* Click **Drop table**.

## Further information

* [Delete table API reference](https://api-docs-featurebase-cloud.redoc.ly/latest#operation/deletetable)
* [Learn how to create tables](/docs/cloud/cloud-tables/cloud-table-create)
13 changes: 11 additions & 2 deletions docs/cloud/cloud-tables/cloud-table-manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Manage tables
layout: default
parent: Cloud
has_children: true
nav_order: 8
nav_order: 7
has_toc: false
---

Expand Down Expand Up @@ -44,10 +44,13 @@ Perform data modeling **before** creating tables to avoid issues.
{% include /cloud-table/cloud-standard-naming-table.md %}
{% include /cloud-table/cloud-standard-naming-col.md%}

## View tables

* Click **Databases** > database name > **Tables**.

## Managing tables in FeatureBase Cloud

* [Create table](/docs/cloud/cloud-tables/cloud-table-create)
* [Upload data](/docs/cloud/cloud-tables/cloud-table-upload-data)
* [Add table columns](/docs/cloud/cloud-tables/cloud-table-add-column)
* [Delete table columns](/docs/cloud/cloud-tables/cloud-table-delete-column)
* [Delete table](/docs/cloud/cloud-tables/cloud-table-delete)
Expand All @@ -56,6 +59,12 @@ Perform data modeling **before** creating tables to avoid issues.

* [Table API reference](https://api-docs-featurebase-cloud.redoc.ly/latest#tag/Tables)

## Managing tables using SQL

* [Create table](/docs/sql-guide/statements/statement-table-create)
* [Alter table](/docs/sql-guide/statements/statement-table-alter)
* [Drop table](/docs/sql-guide/statements/statement-table-create)

## Joining tables

Tables that exist in the same database can be joined.
Expand Down
10 changes: 3 additions & 7 deletions docs/cloud/cloud-tables/cloud-table-query-endpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,7 @@ The query endpoint is used to query a FeatureBase Cloud database.
* [Create a database](/docs/cloud/cloud-databases/cloud-db-create-custom)
* [Create a table](/docs/cloud/cloud-tables/cloud-table-create)

## Step 1: view tables
## Copy the table query endpoint

{% include /cloud-table/cloud-table-view-list.md %}

## Step 2: view the query endpoint

1. Click <span class="material-icons md-18">more_vert</span> for the table to query.
2. Choose **Copy query endpoint**
* Click <span class="material-icons md-18">more_vert</span> for the table to query.
* Choose **Copy query endpoint**
2 changes: 1 addition & 1 deletion docs/sql-guide/data-types/data-types-home.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Data types & constraints
layout: default
parent: SQL guide
has_children: true
nav_order: 2
nav_order: 3
has_toc: false
---

Expand Down
4 changes: 2 additions & 2 deletions docs/sql-guide/examples/sql-eg-home.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: SQL examples
layout: default
parent: SQL guide
nav_order: 7
nav_order: 10
has_toc: false
---

Expand All @@ -20,7 +20,7 @@ Supported SQL statements, data-types, expressions, functions and operators are d
{% include /sql-guide/sql-eg-table-create-statements.md %}

<!-- Excluding because there are no good examples yet
{% include /sql-guide/sql-eg-table-alter-statements.md %}-->
{% include /sql-guide/sql-eg-table-alter-statements.md %} -->

{% include /sql-guide/sql-eg-insert-statements.md %}

Expand Down
2 changes: 1 addition & 1 deletion docs/sql-guide/expressions/expressions-home.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Expressions
layout: default
parent: SQL guide
nav_order: 4
nav_order: 5
---

# SQL Expressions
Expand Down
3 changes: 3 additions & 0 deletions docs/sql-guide/functions/function-identifier.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ grand_parent: SQL guide

# IDENTIFIER() function

{: .note}
`IDENTIFIER()` is supported on [FeatureBase Cloud](/docs/cloud/cloud-home)

`IDENTIFIER()` is used with the `INSERT INTO` statement and automatically generates unique numeric row values for the `_id` column.

## Before you begin
Expand Down
2 changes: 1 addition & 1 deletion docs/sql-guide/functions/functions-home.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Functions
layout: default
parent: SQL guide
has_children: true
nav_order: 3
nav_order: 4
has_toc: false
---

Expand Down
2 changes: 1 addition & 1 deletion docs/sql-guide/hints/hint-flatten.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: FLATTEN()
layout: default
parent: SELECT hints
parent: SQL hints
grand_parent: SQL guide
---

Expand Down
Loading

0 comments on commit 2a81d46

Please sign in to comment.