From 5ea8b673a36a6e031109d23d22ba1dbf1af475cb Mon Sep 17 00:00:00 2001 From: Vladimir Mihailenco Date: Wed, 13 Apr 2022 16:46:39 +0300 Subject: [PATCH] chore: update readme --- README.md | 9 +++++---- example/migrations/README.md | 3 ++- example/opentelemetry/README.md | 5 +++-- example/placeholders/README.md | 4 +++- 4 files changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 7de9b75..d53d031 100644 --- a/README.md +++ b/README.md @@ -18,13 +18,14 @@ Main features are: - ClickHouse native protocol support and efficient column-oriented design. - API compatible with database/sql. - [Bun](https://github.com/uptrace/bun/)-like query builder. -- [Selecting](https://clickhouse.uptrace.dev/guide/query-select.html) into scalars, structs, maps, - slices of maps/structs/scalars. +- [Selecting](https://clickhouse.uptrace.dev/guide/clickhouse-select.html) into scalars, structs, + maps, slices of maps/structs/scalars. - `Array(T)` including nested arrays. - Enums and `LowCardinality(String)`. - `Nullable(T)` except `Nullable(Array(T))`. -- [Migrations](https://clickhouse.uptrace.dev/guide/migrations.html). -- [OpenTelemetry](https://clickhouse.uptrace.dev/guide/monitoring.html) support. +- [Migrations](https://clickhouse.uptrace.dev/guide/clickhouse-migrations.html). +- [OpenTelemetry](https://clickhouse.uptrace.dev/guide/clickhouse-monitoring-performance.html) + support. - In production at [Uptrace](https://uptrace.dev/) Unsupported: diff --git a/example/migrations/README.md b/example/migrations/README.md index dd7b768..4b0d952 100644 --- a/example/migrations/README.md +++ b/example/migrations/README.md @@ -36,4 +36,5 @@ To create a SQL migration: go run . db create_sql sql_migration_name ``` -See [docs](https://clickhouse.uptrace.dev/guide/migrations.html) for details. +See [ClickHouse migrations](https://clickhouse.uptrace.dev/guide/clickhouse-migrations.html) for +details. diff --git a/example/opentelemetry/README.md b/example/opentelemetry/README.md index b2101ee..5bf7096 100644 --- a/example/opentelemetry/README.md +++ b/example/opentelemetry/README.md @@ -1,7 +1,8 @@ # Example for go-clickhouse OpenTelemetry instrumentation -See [Performance and errors monitoring](https://clickhouse.uptrace.dev/guide/monitoring.html) for -details. +See +[Performance and errors monitoring](https://clickhouse.uptrace.dev/guide/clickhouse-monitoring-performance.html) +for details. You can run this example with different OpenTelemetry exporters by providing environment variables. diff --git a/example/placeholders/README.md b/example/placeholders/README.md index f522171..1ccc984 100644 --- a/example/placeholders/README.md +++ b/example/placeholders/README.md @@ -6,4 +6,6 @@ To run this example: go run . ``` -See [docs](https://clickhouse.uptrace.dev/guide/placeholders.html) for details. +See +[ClickHouse SQL placeholders](https://clickhouse.uptrace.dev/guide/clickhouse-sql-placeholders.html) +for details.