Skip to content

Commit

Permalink
Remove folder links in nav
Browse files Browse the repository at this point in the history
  • Loading branch information
rfraposa committed Mar 23, 2023
1 parent dc42298 commit 9658484
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 87 deletions.
2 changes: 1 addition & 1 deletion docs/en/integrations/clickhouse-client-local.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
sidebar_position: 20
slug: /en/integrations/sql-clients/clickhouse-client-local
sidebar_label: clickhouse-client
sidebar_label: clickhouse-client (CLI)
title: Download clickhouse-client and clickhouse-local
---

Expand Down
24 changes: 12 additions & 12 deletions docs/en/integrations/language-clients/nodejs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_label: Nodejs
sidebar_label: Node.js
sidebar_position: 4
keywords: [clickhouse, nodejs, client, connect, integrate]
slug: /en/integrations/language-clients/nodejs
Expand Down Expand Up @@ -118,10 +118,10 @@ tables.

Every method that sends an actual query (`exec`, `insert`, `select`) will provide `query_id` in the result.

This unique identifier is assigned by the client per query, and might be useful to fetch the data from `system.query_log`,
This unique identifier is assigned by the client per query, and might be useful to fetch the data from `system.query_log`,
if it is enabled in the [server configuration](https://clickhouse.com/docs/en/operations/server-configuration-parameters/settings#server_configuration_parameters-query-log).

If necessary, `query_id` can be overridden by the user in `query`/`exec`/`insert` methods params.
If necessary, `query_id` can be overridden by the user in `query`/`exec`/`insert` methods params.

NB: if you override `query_id`, ensure its uniqueness for every call.

Expand Down Expand Up @@ -316,7 +316,7 @@ Provides several convenience methods for data processing in your application.
interface ResultSet {
// See "Query ID" section above
query_id: string

// Consume the entire stream and get the contents as a string
// Can be used with any DataFormat
// Should be called only once
Expand Down Expand Up @@ -651,7 +651,7 @@ Configurations parameters are:
The logging is an experimental feature and is subject to change in the future.
:::

You can enable logging for debugging purposes by setting `CLICKHOUSE_LOG_LEVEL` environment variable.
You can enable logging for debugging purposes by setting `CLICKHOUSE_LOG_LEVEL` environment variable.
Possible values are `OFF`, `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`.

Currently, there are only debug messages, but we will log more in the future.
Expand Down Expand Up @@ -684,15 +684,15 @@ createClient({
})
```

Check an example implementation
Check an example implementation
[here](https://github.com/ClickHouse/clickhouse-js/blob/3aad886231e93c982b0c6e552c87ce7fa72c2caf/__tests__/utils/test_logger.ts#L4-L17).

## TLS certificates

Node.js client optionally supports both basic (Certificate Authority only)
Node.js client optionally supports both basic (Certificate Authority only)
and mutual (Certificate Authority and client certificates) TLS.

Basic TLS configuration example, assuming that you have your certificates in `certs` folder
Basic TLS configuration example, assuming that you have your certificates in `certs` folder
and CA file name is `CA.pem`:

```typescript
Expand Down Expand Up @@ -720,10 +720,10 @@ createClient({
})
```

See full examples
for [basic](https://github.com/ClickHouse/clickhouse-js/blob/main/examples/basic_tls.ts)
and [mutual](https://github.com/ClickHouse/clickhouse-js/blob/main/examples/mutual_tls.ts)
TLS in the repository.
See full examples
for [basic](https://github.com/ClickHouse/clickhouse-js/blob/main/examples/basic_tls.ts)
and [mutual](https://github.com/ClickHouse/clickhouse-js/blob/main/examples/mutual_tls.ts)
TLS in the repository.

## Known limitations

Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ const config = {
{
redirects: [
{ from: '/en/about-us/performance', to: '/en/concepts/why-clickhouse-is-so-fast' },
// { from: '/en/about-us/cloud', to: '/en/cloud/overview' },
{ from: '/en/sql-reference/data-types/nested-data-structures/nested', to: '/en/sql-reference/data-types/nested-data-structures' },
{ from: '/en/guides/improving-query-performance/skipping-indexes', to: '/en/optimize/skipping-indexes' },
{ from: '/en/analyze', to: '/en/sql-reference' },
{ from: '/en/engines', to: '/en/engines/table-engines/' },
Expand Down
81 changes: 8 additions & 73 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,17 +46,15 @@ const sidebars = {
'en/guides/developer/ttl',
'en/guides/developer/deduplication',
'en/sql-reference/dictionaries/index',
'en/guides/developer/lightweight-delete',
'en/guides/developer/transactional',
],
},
{
type: 'category',
label: 'Best Practices',
collapsed: true,
collapsible: true,
link: {
type: 'generated-index',
slug: '/en/optimize',
},
items: [
{
type: 'autogenerated',
Expand All @@ -69,11 +67,8 @@ const sidebars = {
label: 'Example Datasets',
collapsed: true,
collapsible: true,
link: {
type: 'generated-index',
slug: '/en/getting-started/example-datasets',
},
items: [
'en/getting-started/index',
{
type: 'autogenerated',
dirName: 'en/getting-started/example-datasets',
Expand Down Expand Up @@ -155,7 +150,7 @@ const sidebars = {
},
{
type: 'category',
label: 'Clients',
label: 'Clients and Drivers',
collapsed: false,
collapsible: false,
items: [
Expand All @@ -179,13 +174,9 @@ const sidebars = {
},
{
type: 'category',
label: 'Drivers / Interfaces',
label: 'Drivers and Interfaces',
collapsed: true,
collapsible: true,
link: {
type: 'doc',
id: 'en/interfaces/overview',
},
items: [
'en/interfaces/overview',
'en/interfaces/cli',
Expand Down Expand Up @@ -248,21 +239,13 @@ const sidebars = {
label: 'Managing ClickHouse',
collapsed: false,
collapsible: false,
link: {
type: 'generated-index',
slug: 'en/operations'
},
items: [
'en/guides/sre/user-management/index',
'en/operations/backup',
'en/operations/monitoring',
{
type: 'category',
label: 'Security',
link: {
type: 'generated-index',
slug: '/en/manage/security'
},
collapsed: true,
collapsible: true,
items: [
Expand All @@ -275,10 +258,6 @@ const sidebars = {
{
type: 'category',
label: 'External Authentication',
link: {
type: 'doc',
id: 'en/operations/external-authenticators/index',
},
items: [
{
type: 'autogenerated',
Expand All @@ -288,24 +267,20 @@ const sidebars = {
},
]
},
'en/operations/configuration-files',
{
type: 'category',
collapsed: true,
collapsible: true,
label: 'Settings',
link: {
type: 'doc',
id: 'en/operations/settings/index',
},
label: 'Advanced Settings',
items: [
{
type: 'autogenerated',
dirName: 'en/operations/settings'
},
'en/operations/configuration-files',
'en/operations/server-configuration-parameters/settings',
]
},
'en/operations/server-configuration-parameters/settings',
{
type: 'category',
collapsed: true,
Expand All @@ -325,10 +300,6 @@ const sidebars = {
collapsed: true,
collapsible: true,
label: 'Tools and Utilities',
link: {
type: 'doc',
id: 'en/operations/utilities/index',
},
items: [
{
type: 'autogenerated',
Expand All @@ -353,10 +324,6 @@ const sidebars = {
collapsed: true,
collapsible: true,
label: 'System Tables',
link: {
type: 'doc',
id: 'en/operations/system-tables/index',
},
items: [
{
type: 'autogenerated',
Expand Down Expand Up @@ -385,10 +352,6 @@ const sidebars = {
label: 'Contribute',
collapsed: true,
collapsible: true,
link: {
type: 'doc',
id: 'en/development/developer-instruction',
},
items: [
{
type: 'autogenerated',
Expand All @@ -399,10 +362,6 @@ const sidebars = {
label: 'Native Protocol',
collapsed: true,
collapsible: true,
link: {
type: 'doc',
id: 'en/native-protocol/basics',
},
items: [
{
type: 'autogenerated',
Expand Down Expand Up @@ -473,10 +432,6 @@ cloud: [
collapsed: false,
collapsible: false,
className: 'top-nav-item',
link: {
type: 'generated-index',
slug: '/en/cloud/bestpractices',
},
items: [
'en/cloud/bestpractices/bulkinserts',
'en/cloud/bestpractices/asyncinserts',
Expand Down Expand Up @@ -543,10 +498,6 @@ cloud: [
{
type: 'category',
label: 'Data Types',
link: {
type: 'doc',
id: 'en/sql-reference/data-types/index',
},
items: [
{
type: 'autogenerated',
Expand All @@ -557,10 +508,6 @@ cloud: [
{
type: 'category',
label: 'Statements',
link: {
type: 'doc',
id: 'en/sql-reference/statements/index',
},
items: [
{
type: 'autogenerated',
Expand Down Expand Up @@ -593,10 +540,6 @@ cloud: [
label: 'Regular Functions',
collapsed: true,
collapsible: true,
link: {
type: 'doc',
id: 'en/sql-reference/functions/index',
},
items: [
{
type: 'autogenerated',
Expand All @@ -610,10 +553,6 @@ cloud: [
label: 'Aggregate Functions',
collapsed: true,
collapsible: true,
link: {
type: 'doc',
id: 'en/sql-reference/aggregate-functions/index',
},
items: [
{
type: 'autogenerated',
Expand All @@ -627,10 +566,6 @@ cloud: [
label: 'Table Functions',
collapsed: true,
collapsible: true,
link: {
type: 'doc',
id: 'en/sql-reference/table-functions/index',
},
items: [
{
type: 'autogenerated',
Expand Down

0 comments on commit 9658484

Please sign in to comment.