Skip to content

Commit 01167ec

Browse files
authored
Merge pull request #6047 from influxdata/staging/6023-admin-ui-docs-for-cloud-dedicated
feat(dedicated): Admin UI: Add create table, revise create database a…
2 parents 24bdf29 + 815514c commit 01167ec

File tree

7 files changed

+683
-387
lines changed

7 files changed

+683
-387
lines changed

api-docs/influxdb3/cloud-dedicated/management/openapi.yml

Lines changed: 45 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -397,6 +397,26 @@ paths:
397397
post:
398398
operationId: CreateClusterDatabase
399399
summary: Create a database
400+
description: |
401+
Create a database for a cluster.
402+
403+
The database name must be unique within the cluster.
404+
405+
**Default maximum number of columns**: 250
406+
**Default maximum number of tables**: 500
407+
408+
The retention period is specified in nanoseconds. For example, to set a retention period of 1 hour, use `3600000000000`.
409+
410+
InfluxDB Cloud Dedicated lets you define a [custom partitioning](/influxdb3/cloud-dedicated/admin/custom-partitions/) strategy for each database and table.
411+
A _partition_ is a logical grouping of data stored in [Apache Parquet](https://parquet.apache.org/).
412+
By default, data is partitioned by day,
413+
but, depending on your schema and workload, customizing the partitioning
414+
strategy can improve query performance.
415+
416+
To use custom partitioning, you define a [partition template](/influxdb3/cloud-dedicated/admin/custom-partitions/partition-templates/).
417+
If a table doesn't have a custom partition template, it inherits the database's template.
418+
The partition template is set at the time of database creation and cannot be changed later.
419+
For more information, see [Custom partitions](/influxdb3/cloud-dedicated/admin/custom-partitions/).
400420
tags:
401421
- Databases
402422
parameters:
@@ -779,6 +799,18 @@ paths:
779799
post:
780800
operationId: CreateClusterDatabaseTable
781801
summary: Create a database table
802+
description: |
803+
Create a table. The database must already exist. With InfluxDB Cloud Dedicated, tables and measurements are synonymous.
804+
805+
Typically, tables are created automatically on write using the measurement name
806+
specified in line protocol written to InfluxDB.
807+
However, to apply a [custom partition template](/influxdb3/cloud-dedicated/admin/custom-partitions/)
808+
to a table, you must manually [create the table with custom partitioning](/influxdb3/cloud-dedicated/admin/tables/#create-a-table-with-custom-partitioning) before you write any data to it.
809+
810+
Partitioning defaults to `%Y-%m-%d` (daily).
811+
When a partition template is applied to a database, it becomes the default template
812+
for all tables in that database, but can be overridden when creating a
813+
table.
782814
tags:
783815
- Tables
784816
parameters:
@@ -1185,6 +1217,14 @@ paths:
11851217
get:
11861218
operationId: GetDatabaseToken
11871219
summary: Get a database token
1220+
description: |
1221+
Retrieve metadata details for a [database token](/influxdb3/cloud-dedicated/admin/tokens/database/).
1222+
1223+
#### Store secure tokens in a secret store
1224+
1225+
We recommend storing database tokens in a **secure secret store**.
1226+
1227+
Token strings are viewable _only_ on token creation and aren't stored by InfluxDB; you can't recover a lost token.
11881228
tags:
11891229
- Database tokens
11901230
parameters:
@@ -1299,6 +1339,8 @@ paths:
12991339
patch:
13001340
operationId: UpdateDatabaseToken
13011341
summary: Update a database token
1342+
description: |
1343+
Update the description and permissions of a [database token](/influxdb3/cloud-dedicated/admin/tokens/database/).
13021344
tags:
13031345
- Database tokens
13041346
parameters:
@@ -1317,7 +1359,6 @@ paths:
13171359
- name: tokenId
13181360
in: path
13191361
description: The ID of the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) to update
1320-
required: true
13211362
schema:
13221363
$ref: '#/components/schemas/UuidV4'
13231364
requestBody:
@@ -1625,9 +1666,9 @@ components:
16251666
description: |
16261667
A template for [partitioning](/influxdb3/cloud-dedicated/admin/custom-partitions/) a cluster database.
16271668
1628-
Each template part is evaluated in sequence, concatinating the final
1629-
partition key from the output of each part, delimited by the partition
1630-
key delimiter `|`.
1669+
Each partition template part is evaluated in sequence.
1670+
The outputs from each part are concatenated with the
1671+
`|` delimiter to form the final partition key.
16311672
16321673
For example, using the partition template below:
16331674

content/influxdb3/cloud-dedicated/admin/custom-partitions/define-custom-partitions.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,6 @@ source: /shared/v3-distributed-admin-custom-partitions/define-custom-partitions.
1414
---
1515

1616
<!--
17-
The content of this page is at /content/shared/v3-distributed-admin-custom-partitions/_define-custom-partitions.md
17+
The content of this page is at
18+
//SOURCE - content/shared/v3-distributed-admin-custom-partitions/define-custom-partitions.md
1819
-->

0 commit comments

Comments
 (0)