Skip to content

Commit 4bc0654

Browse files
committed
Chore: Fix more broken Sphinx references
1 parent 26168db commit 4bc0654

File tree

5 files changed

+27
-27
lines changed

5 files changed

+27
-27
lines changed

docs/feature/query/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ It is also not in the same shape as the other pages in this section.
230230

231231
[Analyze Device Readings with Metadata Integration]: project:#timeseries-with-metadata
232232
[bulk operations interface]: inv:crate-reference#http-bulk-ops
233-
[bulk operations for INSERTs]: project:#inserts_bulk_operations
233+
[bulk operations for INSERTs]: project:#inserts-bulk-operations
234234
[HyperLogLog]: https://en.wikipedia.org/wiki/HyperLogLog
235235
[HyperLogLog++]: https://research.google/pubs/hyperloglog-in-practice-algorithmic-engineering-of-a-state-of-the-art-cardinality-estimation-algorithm/
236236
[hyperloglog_distinct]: inv:crate-reference#aggregation-hyperloglog-distinct
@@ -239,5 +239,5 @@ It is also not in the same shape as the other pages in this section.
239239
[Introducing: HyperLogLog]: https://cratedb.com/blog/feature-focus-making-things-hyper-fast-fast
240240
[Optimizing storage for historic time-series data]: https://community.cratedb.com/t/optimizing-storage-for-historic-time-series-data/762
241241
[Time Series: Analyze Weather Data]: project:#timeseries-analysis-weather
242-
[UNNEST]: project:#inserts_unnest
242+
[UNNEST]: project:#inserts-unnest
243243
[Window functions in CrateDB]: https://community.cratedb.com/t/window-functions-in-cratedb/1398

docs/performance/inserts/methods.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ Choosing the best insert method is an easy way to improve insert performance.
1313

1414
The three types of insert statements are:
1515

16-
- {ref}`Single inserts <inserts_single_inserts>`
17-
- {ref}`UNNEST <inserts_unnest>`
18-
- {ref}`Multiple value expressions <inserts_multiple_values>`
16+
- {ref}`Single inserts <inserts-single-inserts>`
17+
- {ref}`UNNEST <inserts-unnest>`
18+
- {ref}`Multiple value expressions <inserts-multiple-values>`
1919

2020
Each type of statement can be issued using any of the three types of
21-
{ref}`client approaches <inserts_client_approaches>`, which we cover in
21+
{ref}`client approaches <inserts-client-approaches>`, which we cover in
2222
the next section.
2323

2424
(inserts-single-inserts)=
@@ -150,23 +150,23 @@ method.
150150

151151
The three client approaches for doing inserts are:
152152

153-
- {ref}`Standard querying <inserts_standard_querying>`
154-
- {ref}`Bulk operations <inserts_bulk_operations>`
155-
- {ref}`Prepared statements <inserts_prepared_statements>`
153+
- {ref}`Standard querying <inserts-standard-querying>`
154+
- {ref}`Bulk operations <inserts-bulk-operations>`
155+
- {ref}`Prepared statements <inserts-prepared-statements>`
156156

157157
Each client approach can be used to insert {ref}`any type of insert statement
158-
<insert_statement_types>`.
158+
<insert-statement-types>`.
159159

160160
(inserts-standard-querying)=
161161

162162
### Standard querying
163163

164164
The standard way of issuing insert statements executes one statement at a time
165-
and does not make use of {ref}`inserts_bulk_operations` or any special
166-
{ref}`inserts_prepared_statements` client feature.
165+
and does not make use of {ref}`inserts-bulk-operations` or any special
166+
{ref}`inserts-prepared-statements` client feature.
167167

168168
For example, using the CrateDB Python client, here's a {ref}`single insert
169-
<inserts_single_inserts>`:
169+
<inserts-single-inserts>`:
170170

171171
```python
172172
client.execute("INSERT INTO my_table (column_a) VALUES (?)", ["value 1"])
@@ -180,7 +180,7 @@ You can use the {ref}`bulk operations <crate-reference:http-bulk-ops>` feature
180180
of the {ref}`CrateDB HTTP endpoint <crate-reference:interface-http>` to perform
181181
many inserts in a single operation.
182182

183-
The advantages are the same as using the {ref}`UNNEST method <inserts_unnest>`:
183+
The advantages are the same as using the {ref}`UNNEST method <inserts-unnest>`:
184184

185185
- Significantly less internal network traffic than executing each insert
186186
statement individually
@@ -192,10 +192,10 @@ The advantages are the same as using the {ref}`UNNEST method <inserts_unnest>`:
192192
Because the advantages are the same as using the `UNNEST` method, you
193193
typically will not see a performance improvement by combining bulk operations
194194
with `UNNEST` statements or statements with {ref}`multiple value expressions
195-
<inserts_multiple_values>`.
195+
<inserts-multiple-values>`.
196196

197197
Bulk operations are typically done with {ref}`single insert statements
198-
<inserts_single_inserts>` as an alternative to the `UNNEST` method.
198+
<inserts-single-inserts>` as an alternative to the `UNNEST` method.
199199

200200
:::{SEEALSO}
201201
{ref}`Performance: Bulk inserts <bulk-inserts>`
@@ -235,20 +235,20 @@ use the binary protocol, contain almost no headers, and are executed over an
235235
already established connection.
236236

237237
Typically, prepared statements are used {ref}`single insert statements
238-
<inserts_single_inserts>`.
238+
<inserts-single-inserts>`.
239239

240240
Prepared statements with single inserts will usually perform better than
241-
{ref}`standard querying <inserts_standard_querying>` with single inserts, and
241+
{ref}`standard querying <inserts-standard-querying>` with single inserts, and
242242
should be comparable to standard querying with both the {ref}`UNNEST
243-
method <inserts_unnest>` and {ref}`multiple value expressions
244-
<inserts_multiple_values>`.
243+
method <inserts-unnest>` and {ref}`multiple value expressions
244+
<inserts-multiple-values>`.
245245

246246
## Testing
247247

248248
Follow the basic {ref}`inserts performance testing
249-
<testing_inserts_performance>` procedure.
249+
<testing-inserts-performance>` procedure.
250250

251-
To test {ref}`bulk operations <inserts_bulk_operations>`, you should:
251+
To test {ref}`bulk operations <inserts-bulk-operations>`, you should:
252252

253253
1. Configure the setup you would like to test
254254
2. Run a number of different tests against that setup, using different

docs/performance/inserts/parallel.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ response before sending another insert.
1818

1919
:::{NOTE}
2020
Before trying to parallelize your queries, you should evaluate whether
21-
{ref}`inserts_bulk_operations` are a good fit. In many cases, you will see
21+
{ref}`inserts-bulk-operations` are a good fit. In many cases, you will see
2222
even better performance from bulk opperations.
2323
:::
2424

@@ -81,7 +81,7 @@ You can provide your own [Executor] using any object with the appropriate
8181
## Testing
8282

8383
Follow the basic {ref}`inserts performance testing
84-
<testing_inserts_performance>` procedure.
84+
<testing-inserts-performance>` procedure.
8585

8686
To test parallel inserts, you should:
8787

docs/performance/inserts/tuning.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ event of node failure or cluster partitions, but they do incur a performance cos
5959

6060
### Shards and partitioning
6161

62-
The {ref}`sharding guide <sharding_guide>` has a section that covers
63-
{ref}`ingestion performance <sharding_ingestion>`.
62+
The {ref}`sharding guide <sharding-guide>` has a section that covers
63+
{ref}`ingestion performance <sharding-ingestion>`.
6464

6565
### Indexing
6666

docs/performance/scaling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ cluster.
5959

6060
Having too many or too few shards has performance implications, so it is very
6161
important to get familiar with the {ref}`Sharding Performance Guide
62-
<sharding_guide>`.
62+
<sharding-guide>`.
6363

6464
In particular, there is a soft limit of 1000 shards per node; so table schemas,
6565
partitioning strategy, and number of nodes need to be planned to stay well below

0 commit comments

Comments
 (0)