Skip to content

Commit 7ccaed5

Browse files
authored
docs: Clarify the database name in SQL API (#7098)
1 parent 65803de commit 7ccaed5

File tree

1 file changed

+13
-7
lines changed
  • docs/docs-new/pages/product/apis-integrations

1 file changed

+13
-7
lines changed

docs/docs-new/pages/product/apis-integrations/sql-api.mdx

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,19 +57,25 @@ suggest tools of your interest and vote for already proposed ones.
5757

5858
### Cube Core
5959

60-
SQL API is disabled by default. To enable the SQL API, set the
61-
`CUBEJS_PG_SQL_PORT` to a port number you'd like to connect to with a
62-
Postgres-compatible tool.
63-
64-
Use `CUBEJS_SQL_USER` and `CUBEJS_SQL_PASSWORD` to configure credentials
65-
required to connect to the SQL API. You can also use
60+
**SQL API is disabled by default.** To enable the SQL API, set `CUBEJS_PG_SQL_PORT`
61+
to a port number you'd like to connect to with a Postgres-compatible tool.
62+
63+
| Credential | Environment variable, etc. |
64+
|:---------- |:------------------------------ |
65+
| Host | Host you're running Cube at |
66+
| Port | Set via `CUBEJS_PG_SQL_PORT` |
67+
| User name | Set via `CUBEJS_SQL_USER` |
68+
| Password | Set via `CUBEJS_SQL_PASSWORD` |
69+
| Database | Any valid string, e.g., `cube` |
70+
71+
You can also use
6672
[`checkSqlAuth`][ref-config-checksqlauth],
6773
[`canSwitchSqlUser`][ref-config-canswitchsqluser], and `CUBEJS_SQL_SUPER_USER`
6874
to configure [custom authentication][ref-sql-api-auth].
6975

7076
### Cube Cloud
7177

72-
SQL API is enabled by default. You can find credentials for the SQL API on
78+
**SQL API is enabled by default.** You can find credentials for the SQL API on
7379
the <Btn>Overview</Btn> page by clicking <Btn>Connect to SQL API</Btn>.
7480

7581
You can also customize `CUBEJS_PG_SQL_PORT`, `CUBEJS_SQL_USER`, and

0 commit comments

Comments
 (0)