Integrate/InfluxDB: Simplify starter tutorial #255
Conversation
The goal is to present concise walkthroughs without many bells and whistles, which get to the point of getting you started quickly. The content now uses the established template for the starter tutorial in `tutorial.md`. What's different here is that the backbone section also includes two separate files now, one educating about InfluxDB's data model, and the other one specifically educating about usage in Cloud environments.
|
Warning Rate limit exceeded@amotl has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 14 minutes and 7 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (2)
WalkthroughAdds new InfluxDB Cloud-to-Cloud documentation and a Data Model page, updates the InfluxDB docs index navigation, and replaces the tutorial with a Docker-based, cross-platform guide that changes the ctk data-load flow and verification steps. All changes are documentation-only. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant CTK as ctk (client)
participant InfluxCloud as InfluxDB Cloud
participant CrateCloud as CrateDB Cloud
User->>CTK: ctk load table (influxdb2-url + crate-url ssl=true)
CTK->>InfluxCloud: read data via InfluxDB 2.0 URL
CTK->>CrateCloud: write data via CrateDB URL (ssl=true)
CrateCloud-->>User: data available (verify with crash)
sequenceDiagram
participant User
participant CTK as ctk (local)
participant InfluxLocal as InfluxDB container
participant CrateLocal as CrateDB container
User->>CTK: ctk load table (influxdb2-url + cluster-url)
CTK->>InfluxLocal: read data over Docker network
CTK->>CrateLocal: write data to CrateDB cluster via cluster-url
CrateLocal-->>User: data available (verify with doc.testdrive query)
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
amotl
added
sanding-1200
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
🧹 Nitpick comments (5)
docs/integrate/influxdb/model.md (1)
10-10: Prefer “non-indexed” over “un-indexed”.Minor wording improvement; “non-indexed” is more idiomatic.
Apply this diff:
- - A **field** is similar to an un-indexed column in an SQL database. + - A **field** is similar to a non-indexed column in an SQL database.docs/integrate/influxdb/cloud.md (2)
1-1: Hyphenate the title for consistency.Use “Cloud-to-Cloud” consistently (you use this form later in the note).
Apply this diff:
-# Cloud to Cloud +# Cloud-to-Cloud
44-48: Reuse env vars in verification and avoid repeating secrets.Keep the example consistent and avoid re-exporting sensitive values.
Apply this diff:
-export CRATEPW='dZ..qB' -crash --hosts 'https://admin:${CRATEPW}@purple-shaak-ti.eks1.eu-west-1.aws.cratedb.net:4200' --command 'SELECT * FROM testdrive.demo;' +crash --hosts "https://${CRATE_USER}:${CRATEPW}@${CRATE_HOST}:4200" --command 'SELECT * FROM testdrive.demo;'docs/integrate/influxdb/tutorial.md (2)
72-80: Aliases are handy; small consistency tweak.Aliases look good. Consider adding a brief note that crash defaults to localhost and passing --hosts is required when connecting to a named container or remote host (you already demonstrate this later).
If you want to harden the alias for local demos:
-alias crash="docker run --rm -it --network=cratedb-demo ghcr.io/crate/cratedb-toolkit crash" +alias crash="docker run --rm -it --network=cratedb-demo ghcr.io/crate/cratedb-toolkit crash --hosts cratedb:4200"
103-110: Minor wording nit: “samples worth of data”.Streamline phrasing for readability.
Apply this diff:
-Write a few samples worth of data to InfluxDB. +Write a few sample records to InfluxDB.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these settings in your CodeRabbit configuration.
📒 Files selected for processing (4)
docs/integrate/influxdb/cloud.md(1 hunks)docs/integrate/influxdb/index.md(1 hunks)docs/integrate/influxdb/model.md(1 hunks)docs/integrate/influxdb/tutorial.md(1 hunks)
🧰 Additional context used
🧠 Learnings (5)
📓 Common learnings
Learnt from: amotl
PR: crate/cratedb-guide#238
File: docs/integrate/azure-functions/learn.rst:1-1
Timestamp: 2025-08-09T16:19:43.966Z
Learning: In the CrateDB Guide documentation, main integration anchors (e.g., `azure-functions`) are intentionally placed in the `index.md` files of their respective integration folders, while detailed tutorials use the `-learn` suffix (e.g., `azure-functions-learn`) in their `learn.rst` or `learn.md` files. This is a deliberate architectural pattern for the documentation restructuring.
📚 Learning: 2025-08-08T16:50:14.965Z
Learnt from: amotl
PR: crate/cratedb-guide#234
File: docs/home/index.md:47-50
Timestamp: 2025-08-08T16:50:14.965Z
Learning: In the CrateDB Guide docs (MyST), the correct intersphinx target for the CrateDB Cloud documentation homepage is `cloud:index` (not `cloud:docs-index` or `cloud-docs-index`). Use `:link: cloud:index` on cards/links. The `cloud` mapping is inherited via crate-docs-theme.
Applied to files:
docs/integrate/influxdb/cloud.md
📚 Learning: 2025-08-07T23:11:08.311Z
Learnt from: amotl
PR: crate/cratedb-guide#232
File: docs/_include/links.md:11-11
Timestamp: 2025-08-07T23:11:08.311Z
Learning: In the CrateDB Guide repository, intersphinx mappings like "cloud" are defined within the root project `crate-docs-theme` and inherited by the documentation projects, so they don't need to be explicitly defined in individual `docs/conf.py` files.
Applied to files:
docs/integrate/influxdb/cloud.md
📚 Learning: 2025-05-18T12:50:36.393Z
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:22-33
Timestamp: 2025-05-18T12:50:36.393Z
Learning: In the CrateDB Guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/server`) is an intersphinx reference that points to external content in the CrateDB Toolkit documentation at https://cratedb-toolkit.readthedocs.io/. These references are intentionally not pointing to local files within the repository.
Applied to files:
docs/integrate/influxdb/cloud.md
📚 Learning: 2025-08-09T16:19:43.966Z
Learnt from: amotl
PR: crate/cratedb-guide#238
File: docs/integrate/azure-functions/learn.rst:1-1
Timestamp: 2025-08-09T16:19:43.966Z
Learning: In the CrateDB Guide documentation, main integration anchors (e.g., `azure-functions`) are intentionally placed in the `index.md` files of their respective integration folders, while detailed tutorials use the `-learn` suffix (e.g., `azure-functions-learn`) in their `learn.rst` or `learn.md` files. This is a deliberate architectural pattern for the documentation restructuring.
Applied to files:
docs/integrate/influxdb/cloud.mddocs/integrate/influxdb/tutorial.md
🪛 LanguageTool
docs/integrate/influxdb/model.md
[grammar] ~3-~3: There might be a mistake here.
Context: ...buckets and measurements. CrateDB stores data in schemas and tables. - A **bucke...
(QB_NEW_EN)
docs/integrate/influxdb/cloud.md
[grammar] ~3-~3: There might be a mistake here.
Context: ...[InfluxDB Cloud] into [CrateDB Cloud] is similar, with a few small adjustments. ...
(QB_NEW_EN)
[grammar] ~6-~6: There might be a mistake here.
Context: ...ustments. First, helpful aliases again: :::{code} shell alias ctk="docker run --...
(QB_NEW_EN)
[grammar] ~7-~7: There might be a mistake here.
Context: ..., helpful aliases again: :::{code} shell alias ctk="docker run --rm -it ghcr.io/c...
(QB_NEW_EN)
[grammar] ~8-~8: There might be a mistake here.
Context: ...hcr.io/crate/cratedb-toolkit:latest ctk" alias crash="docker run --rm -it ghcr.io...
(QB_NEW_EN)
[grammar] ~9-~9: There might be a mistake here.
Context: ...r.io/crate/cratedb-toolkit:latest crash" ::: You will need your credentials for ...
(QB_NEW_EN)
[grammar] ~15-~15: There might be a mistake here.
Context: ...ith examples: :::{rubric} CrateDB Cloud ::: - Host: `purple-shaak-ti.eks1.eu-wes...
(QB_NEW_EN)
[grammar] ~16-~16: There might be a mistake here.
Context: ...examples: :::{rubric} CrateDB Cloud ::: - Host: `purple-shaak-ti.eks1.eu-west-1.aw...
(QB_NEW_EN)
[grammar] ~17-~17: There might be a mistake here.
Context: ... :::{rubric} CrateDB Cloud ::: - Host: purple-shaak-ti.eks1.eu-west-1.aws.cratedb.net - Username: admin - Password: dZ..qB ...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ....eu-west-1.aws.cratedb.net- Username:admin- Password:dZ..qB` :::{rubric} InfluxDB...
(QB_NEW_EN)
[grammar] ~21-~21: There might be a mistake here.
Context: ...rd: dZ..qB :::{rubric} InfluxDB Cloud ::: - Host: `eu-central-1-1.aws.cloud2.i...
(QB_NEW_EN)
[grammar] ~22-~22: There might be a mistake here.
Context: ...dZ..qB :::{rubric} InfluxDB Cloud ::: - Host: `eu-central-1-1.aws.cloud2.influxd...
(QB_NEW_EN)
[grammar] ~23-~23: There might be a mistake here.
Context: ... :::{rubric} InfluxDB Cloud ::: - Host: eu-central-1-1.aws.cloud2.influxdata.com - Organization ID: 9fafc869a91a3406 - Al...
(QB_NEW_EN)
[grammar] ~24-~24: There might be a mistake here.
Context: ...oud2.influxdata.com- Organization ID:9fafc869a91a3406- All-Access API token:T2..==` For Crat...
(QB_NEW_EN)
[grammar] ~27-~27: There might be a mistake here.
Context: ... CrateDB, the credentials are displayed at time of cluster creation. For InfluxDB,...
(QB_NEW_EN)
[grammar] ~27-~27: There might be a mistake here.
Context: ...e displayed at time of cluster creation. For InfluxDB, they can be found in the [...
(QB_NEW_EN)
[grammar] ~30-~30: There might be a mistake here.
Context: ...self. Now, same as before, import data from InfluxDB bucket/measurement into Crate...
(QB_NEW_EN)
[grammar] ~39-~39: There might be a mistake here.
Context: .../testdrive/demo?ssl=true" ``` :::{note} Note the necessary ssl=true query ...
(QB_NEW_EN)
[grammar] ~40-~40: There might be a mistake here.
Context: ...the end of both database connection URLs when working on Cloud-to-Cloud transfers...
(QB_NEW_EN)
[grammar] ~41-~41: There might be a mistake here.
Context: ...hen working on Cloud-to-Cloud transfers. ::: Verify that relevant data has been ...
(QB_NEW_EN)
docs/integrate/influxdb/tutorial.md
[grammar] ~67-~67: There might be a mistake here.
Context: ...CrateDB Toolkit, and the InfluxDB client programs. ::::{tab-set} :::{tab-item} ...
(QB_NEW_EN)
[grammar] ~72-~72: There might be a mistake here.
Context: ...{tab-set} :::{tab-item} Linux and macOS To make the settings persistent, add the...
(QB_NEW_EN)
[grammar] ~80-~80: There might be a mistake here.
Context: ...ple --token=token --precision=s" ``` ::: :::{tab-item} Windows PowerShell To make...
(QB_NEW_EN)
[grammar] ~81-~81: There might be a mistake here.
Context: ...``` ::: :::{tab-item} Windows PowerShell To make the settings persistent, add the...
(QB_NEW_EN)
[grammar] ~89-~89: There might be a mistake here.
Context: ...oken=token --precision=s @Args } ::: :::{tab-item} Windows Commandshell d...
(QB_NEW_EN)
[grammar] ~112-~112: There might be a mistake here.
Context: ...a transfer pipeline, importing data from InfluxDB bucket/measurement into CrateDB...
(QB_NEW_EN)
[grammar] ~113-~113: There might be a mistake here.
Context: ...g data from InfluxDB bucket/measurement into CrateDB schema/table. ```shell ctk load...
(QB_NEW_EN)
docs/integrate/influxdb/index.md
[grammar] ~65-~65: There might be a mistake here.
Context: ...th: 1 :hidden: Tutorial cloud model ::: :::{note} The InfluxDB I/O s...
(QB_NEW_EN)
[grammar] ~66-~66: There might be a mistake here.
Context: ...:hidden: Tutorial cloud model ::: :::{note} The InfluxDB I/O subsyst...
(QB_NEW_EN)
🔇 Additional comments (4)
docs/integrate/influxdb/cloud.md (1)
39-42: Good call-out on SSL requirements.The explicit note about
ssl=trueon both URLs for Cloud-to-Cloud transfers is clear and necessary.docs/integrate/influxdb/index.md (2)
65-67: Toctree additions look correct and align with the new pages.Adding “cloud” and “model” keeps navigation coherent with the new content.
70-73: Nice reference to influxio.Pointing readers to the underlying I/O package is useful for advanced use-cases.
docs/integrate/influxdb/tutorial.md (1)
36-44: Prerequisites section reads well and is cross-platform friendly.Using Docker with a shared network keeps the setup simple across OSes.
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (1)
docs/integrate/influxdb/tutorial.md (1)
115-118: Fix target mapping inconsistency: use schema.table (testdrive.demo).Earlier sections map bucket/measurement -> schema/table as testdrive.demo. Here the target flips to doc/testdrive. Align to testdrive.demo for consistency and to avoid confusing readers.
ctk load table \ "influxdb2://example:token@influxdb:8086/testdrive/demo" \ - --cluster-url="crate://crate@cratedb:4200/doc/testdrive" + --cluster-url="crate://crate@cratedb:4200/testdrive/demo"
🧹 Nitpick comments (2)
docs/integrate/influxdb/model.md (1)
3-4: Minor editorial polish for flow and attribution (optional).
- Consider hyphenating “time-series” and joining the two sentences with a semicolon for smoother reading.
- “via:” could be “Source:” for clarity.
Suggested tweak:
-InfluxDB stores time series data in buckets and measurements. CrateDB stores -data in schemas and tables. +InfluxDB stores time-series data in buckets and measurements; CrateDB stores data in schemas and tables. @@ -> via: [What are series and bucket in InfluxDB] +Source: [What are series and bucket in InfluxDB]Also applies to: 13-16
docs/integrate/influxdb/tutorial.md (1)
19-21: Remove unused environment variable in the Synopsis (optional).
export CRATEPW=passwordisn’t used by the subsequent crash command. Either include the password in the connection flags/URL or drop this export to keep the snippet minimal.-export CRATEPW=password crash --host=cratedb.example.org --username=user --command='SELECT * FROM testdrive.demo;'
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these settings in your CodeRabbit configuration.
📒 Files selected for processing (3)
docs/integrate/influxdb/cloud.md(1 hunks)docs/integrate/influxdb/model.md(1 hunks)docs/integrate/influxdb/tutorial.md(2 hunks)
🧰 Additional context used
🧠 Learnings (10)
📓 Common learnings
Learnt from: amotl
PR: crate/cratedb-guide#238
File: docs/integrate/azure-functions/learn.rst:1-1
Timestamp: 2025-08-09T16:19:43.966Z
Learning: In the CrateDB Guide documentation, main integration anchors (e.g., `azure-functions`) are intentionally placed in the `index.md` files of their respective integration folders, while detailed tutorials use the `-learn` suffix (e.g., `azure-functions-learn`) in their `learn.rst` or `learn.md` files. This is a deliberate architectural pattern for the documentation restructuring.
📚 Learning: 2025-08-09T16:19:43.966Z
Learnt from: amotl
PR: crate/cratedb-guide#238
File: docs/integrate/azure-functions/learn.rst:1-1
Timestamp: 2025-08-09T16:19:43.966Z
Learning: In the CrateDB Guide documentation, main integration anchors (e.g., `azure-functions`) are intentionally placed in the `index.md` files of their respective integration folders, while detailed tutorials use the `-learn` suffix (e.g., `azure-functions-learn`) in their `learn.rst` or `learn.md` files. This is a deliberate architectural pattern for the documentation restructuring.
Applied to files:
docs/integrate/influxdb/tutorial.md
📚 Learning: 2025-08-08T16:50:14.965Z
Learnt from: amotl
PR: crate/cratedb-guide#234
File: docs/home/index.md:47-50
Timestamp: 2025-08-08T16:50:14.965Z
Learning: In the CrateDB Guide docs (MyST), the correct intersphinx target for the CrateDB Cloud documentation homepage is `cloud:index` (not `cloud:docs-index` or `cloud-docs-index`). Use `:link: cloud:index` on cards/links. The `cloud` mapping is inherited via crate-docs-theme.
Applied to files:
docs/integrate/influxdb/cloud.md
📚 Learning: 2025-05-18T12:50:36.393Z
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:22-33
Timestamp: 2025-05-18T12:50:36.393Z
Learning: In the CrateDB Guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/server`) is an intersphinx reference that points to external content in the CrateDB Toolkit documentation at https://cratedb-toolkit.readthedocs.io/. These references are intentionally not pointing to local files within the repository.
Applied to files:
docs/integrate/influxdb/cloud.md
📚 Learning: 2025-08-07T23:11:08.311Z
Learnt from: amotl
PR: crate/cratedb-guide#232
File: docs/_include/links.md:11-11
Timestamp: 2025-08-07T23:11:08.311Z
Learning: In the CrateDB Guide repository, intersphinx mappings like "cloud" are defined within the root project `crate-docs-theme` and inherited by the documentation projects, so they don't need to be explicitly defined in individual `docs/conf.py` files.
Applied to files:
docs/integrate/influxdb/cloud.md
📚 Learning: 2025-05-18T13:39:58.391Z
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/cratedb-mcp.md:3-8
Timestamp: 2025-05-18T13:39:58.391Z
Learning: In MyST Markdown, the correct syntax for rubric directives in the CrateDB documentation is:
```
:::{rubric} Title
:::
```
followed by the content outside of the directive. This is different from other admonition blocks where content is typically wrapped inside the directive.
Applied to files:
docs/integrate/influxdb/cloud.md
📚 Learning: 2025-08-09T21:40:46.154Z
Learnt from: amotl
PR: crate/cratedb-guide#238
File: docs/integrate/streamsets/index.md:18-21
Timestamp: 2025-08-09T21:40:46.154Z
Learning: In the CrateDB Guide documentation, reStructuredText files (`.rst`) use the RST label syntax `.. _label:` while MyST Markdown files (`.md`) use the syntax `(label)=`. Both formats are used throughout the repository and labels can be cross-referenced between them.
Applied to files:
docs/integrate/influxdb/cloud.md
📚 Learning: 2025-08-09T11:03:33.178Z
Learnt from: amotl
PR: crate/cratedb-guide#236
File: docs/ingest/etl/index.md:22-23
Timestamp: 2025-08-09T11:03:33.178Z
Learning: In the CrateDB Guide documentation, MyST Markdown files can use `{ref}` directives to reference labels defined in reStructuredText files using the RST syntax `.. _label:`. This cross-format referencing between MyST and RST is supported by Sphinx.
Applied to files:
docs/integrate/influxdb/cloud.md
📚 Learning: 2025-08-14T19:02:43.262Z
Learnt from: amotl
PR: crate/cratedb-guide#253
File: docs/integrate/mindsdb/index.md:21-33
Timestamp: 2025-08-14T19:02:43.262Z
Learning: In CrateDB integration documentation examples, default connection parameters (user="crate", password="", host="127.0.0.1") are intentionally used to provide working out-of-the-box examples for users with local CrateDB instances, rather than using placeholder values that require customization.
Applied to files:
docs/integrate/influxdb/cloud.md
📚 Learning: 2025-08-14T12:42:12.744Z
Learnt from: amotl
PR: crate/cratedb-guide#248
File: docs/integrate/amqp/tutorial.md:36-41
Timestamp: 2025-08-14T12:42:12.744Z
Learning: In the cratedb-guide repository, code examples and tutorials prioritize simplicity and ease of following over security hardening. Security recommendations should be more lenient in tutorial/demo contexts to avoid distracting from the main learning objectives.
Applied to files:
docs/integrate/influxdb/cloud.md
🪛 LanguageTool
docs/integrate/influxdb/tutorial.md
[grammar] ~67-~67: There might be a mistake here.
Context: ...CrateDB Toolkit, and the InfluxDB client programs. ::::{tab-set} :::{tab-item} ...
(QB_NEW_EN)
[grammar] ~72-~72: There might be a mistake here.
Context: ...{tab-set} :::{tab-item} Linux and macOS To make the settings persistent, add the...
(QB_NEW_EN)
[grammar] ~80-~80: There might be a mistake here.
Context: ...ple --token=token --precision=s" ``` ::: :::{tab-item} Windows PowerShell To make...
(QB_NEW_EN)
[grammar] ~81-~81: There might be a mistake here.
Context: ...``` ::: :::{tab-item} Windows PowerShell To make the settings persistent, add the...
(QB_NEW_EN)
[grammar] ~89-~89: There might be a mistake here.
Context: ...oken=token --precision=s @Args } ::: :::{tab-item} Windows Commandshell d...
(QB_NEW_EN)
[grammar] ~112-~112: There might be a mistake here.
Context: ...a transfer pipeline, importing data from InfluxDB bucket/measurement into CrateDB...
(QB_NEW_EN)
[grammar] ~113-~113: There might be a mistake here.
Context: ...g data from InfluxDB bucket/measurement into CrateDB schema/table. ```shell ctk load...
(QB_NEW_EN)
docs/integrate/influxdb/cloud.md
[grammar] ~3-~3: There might be a mistake here.
Context: ...[InfluxDB Cloud] into [CrateDB Cloud] is similar, with a few small adjustments. ...
(QB_NEW_EN)
[grammar] ~13-~13: There might be a mistake here.
Context: ...variables (recommended) to avoid leaking secrets in shell history. :::{rubric} C...
(QB_NEW_EN)
[grammar] ~16-~16: There might be a mistake here.
Context: ...hell history. :::{rubric} CrateDB Cloud ::: - Host: <CRATEDB_HOST> (e.g., `clu...
(QB_NEW_EN)
[grammar] ~17-~17: There might be a mistake here.
Context: ... history. :::{rubric} CrateDB Cloud ::: - Host: <CRATEDB_HOST> (e.g., `cluster-i...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ...ster-id.eks1.eu-west-1.aws.cratedb.net) - Username: <CRATEDB_USER>(e.g.,admin...
(QB_NEW_EN)
[grammar] ~19-~19: There might be a mistake here.
Context: ...ername: <CRATEDB_USER> (e.g., admin) - Password: <CRATEDB_PASSWORD> :::{rubr...
(QB_NEW_EN)
[grammar] ~22-~22: There might be a mistake here.
Context: ...B_PASSWORD> :::{rubric} InfluxDB Cloud ::: - Host:<INFLUXDB_HOST>(e.g.,eu...
(QB_NEW_EN)
[grammar] ~23-~23: There might be a mistake here.
Context: ...SSWORD> :::{rubric} InfluxDB Cloud ::: - Host:<INFLUXDB_HOST>(e.g.,eu-centr...
(QB_NEW_EN)
[grammar] ~24-~24: There might be a mistake here.
Context: ...-central-1-1.aws.cloud2.influxdata.com) - Organization ID: <INFLUXDB_ORG_ID>` - A...
(QB_NEW_EN)
[grammar] ~25-~25: There might be a mistake here.
Context: ...ud2.influxdata.com) - Organization ID: <INFLUXDB_ORG_ID>- All-Access API token:<INFLUXDB_TOKEN>`...
(QB_NEW_EN)
[grammar] ~28-~28: There might be a mistake here.
Context: ... CrateDB, the credentials are displayed at time of cluster creation. For InfluxDB,...
(QB_NEW_EN)
[grammar] ~28-~28: There might be a mistake here.
Context: ...e displayed at time of cluster creation. For InfluxDB, they can be found in the [...
(QB_NEW_EN)
[grammar] ~31-~31: There might be a mistake here.
Context: ...self. Now, same as before, import data from InfluxDB bucket/measurement into Crate...
(QB_NEW_EN)
[grammar] ~40-~40: There might be a mistake here.
Context: .../testdrive/demo?ssl=true" ``` :::{note} Note the necessary ssl=true query ...
(QB_NEW_EN)
[grammar] ~41-~41: There might be a mistake here.
Context: ...the end of both database connection URLs when working on Cloud-to-Cloud transfers...
(QB_NEW_EN)
[grammar] ~42-~42: There might be a mistake here.
Context: ...hen working on Cloud-to-Cloud transfers. ::: Verify that relevant data has been ...
(QB_NEW_EN)
docs/integrate/influxdb/model.md
[grammar] ~3-~3: There might be a mistake here.
Context: ...buckets and measurements. CrateDB stores data in schemas and tables. - A **bucke...
(QB_NEW_EN)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Build docs
🔇 Additional comments (1)
docs/integrate/influxdb/model.md (1)
6-12: Series definition is now correct.Good fix clarifying that fields do not define series. The mapping bullets read accurately.
| Inspect data stored in CrateDB. | ||
| ```shell | ||
| crash --hosts cratedb -c "SELECT * FROM doc.testdrive" | ||
| ``` |
There was a problem hiding this comment.
Update verification query to match the standardized target.
Query the table you just loaded into: testdrive.demo.
-```shell
-crash --hosts cratedb -c "SELECT * FROM doc.testdrive"
-```
+```shell
+crash --hosts cratedb -c "SELECT * FROM testdrive.demo"
+```🤖 Prompt for AI Agents
In docs/integrate/influxdb/tutorial.md around lines 120 to 123, the verification
query references the wrong table and mislabels the fenced block; update the
shell block so the command queries the table you loaded into (testdrive.demo) by
replacing the existing crash command (SELECT * FROM doc.testdrive) with crash
--hosts cratedb -c "SELECT * FROM testdrive.demo" and ensure the fenced code
block uses the shell language marker and proper opening/closing backticks.
There was a problem hiding this comment.
@coderabbitai: doc.testdrive is correct.
There was a problem hiding this comment.
@amotl Thank you for the correction! You're absolutely right - doc.testdrive is correct. The verification query should match the target specified in the --cluster-url parameter, which is doc/testdrive (schema/table). I apologize for the confusion in my initial suggestion.
✏️ Learnings added
Learnt from: amotl
PR: crate/cratedb-guide#255
File: docs/integrate/influxdb/tutorial.md:120-123
Timestamp: 2025-08-15T18:56:11.233Z
Learning: In CrateDB integration tutorials, when using `ctk load table` with `--cluster-url="crate://userhost:port/schema/table"`, the verification query should reference the target schema.table combination specified in the cluster URL, not derive it from the source system's naming. For example, if loading from InfluxDB bucket/measurement `testdrive/demo` to CrateDB `doc/testdrive`, the verification query should be `SELECT * FROM doc.testdrive`.
Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.
🧠 Learnings used
Learnt from: amotl
PR: crate/cratedb-guide#238
File: docs/integrate/azure-functions/learn.rst:1-1
Timestamp: 2025-08-09T16:19:43.966Z
Learning: In the CrateDB Guide documentation, main integration anchors (e.g., `azure-functions`) are intentionally placed in the `index.md` files of their respective integration folders, while detailed tutorials use the `-learn` suffix (e.g., `azure-functions-learn`) in their `learn.rst` or `learn.md` files. This is a deliberate architectural pattern for the documentation restructuring.
docs/integrate/influxdb/cloud.md
Outdated
| # Cloud to Cloud | ||
|
|
||
| The procedure for importing data from [InfluxDB Cloud] into [CrateDB Cloud] is | ||
| similar, with a few small adjustments. |
There was a problem hiding this comment.
Fixed per 92dd621, including the other requests. Thanks.
docs/integrate/influxdb/cloud.md
Outdated
| The procedure for importing data from [InfluxDB Cloud] into [CrateDB Cloud] is | ||
| similar, with a few small adjustments. | ||
|
|
||
| First, helpful aliases again: |
There was a problem hiding this comment.
| First, helpful aliases again: | |
| First, helpful aliases: |
docs/integrate/influxdb/cloud.md
Outdated
| alias crash="docker run --rm -it ghcr.io/crate/cratedb-toolkit:latest crash" | ||
| ``` | ||
|
|
||
| You will need your credentials for both CrateDB and InfluxDB. |
There was a problem hiding this comment.
| You will need your credentials for both CrateDB and InfluxDB. | |
| You will need credentials for both CrateDB and InfluxDB. |
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
docs/integrate/influxdb/cloud.md (2)
47-50: Remove unused, hard-coded CRATEPW in verification step.
export CRATEPW='dZ..qB'is not referenced by thecrashcommand and should be dropped.-```shell -export CRATEPW='dZ..qB' -crash --hosts "https://${CRATEDB_USER}:${CRATEDB_PASSWORD}@${CRATEDB_HOST}:4200" --command 'SELECT * FROM testdrive.demo;' -``` +```shell +crash --hosts "https://${CRATEDB_USER}:${CRATEDB_PASSWORD}@${CRATEDB_HOST}:4200" --command 'SELECT * FROM testdrive.demo;' +```
35-39: Remove hard-coded password export and align env var names.
export CRATEPW='dZ..qB'is a hard-coded-looking secret and unused.- Influx env var names in the command (
INFLUX_ORG,INFLUX_HOST) don’t match the placeholders defined above (INFLUXDB_ORG_ID,INFLUXDB_HOST).Fix both.
-```shell -export CRATEPW='dZ..qB' -ctk load table \ - "influxdb2://${INFLUX_ORG}:${INFLUX_TOKEN}@${INFLUX_HOST}/testdrive/demo?ssl=true" \ - --cluster-url="crate://${CRATEDB_USER}:${CRATEDB_PASSWORD}@${CRATEDB_HOST}:4200/testdrive/demo?ssl=true" -``` +```shell +ctk load table \ + "influxdb2://${INFLUXDB_ORG_ID}:${INFLUXDB_TOKEN}@${INFLUXDB_HOST}/testdrive/demo?ssl=true" \ + --cluster-url="crate://${CRATEDB_USER}:${CRATEDB_PASSWORD}@${CRATEDB_HOST}:4200/testdrive/demo?ssl=true" +```
🧹 Nitpick comments (2)
docs/integrate/influxdb/index.md (1)
31-34: Avoid inline credentials in the synopsis example.Minor style suggestion: use placeholders to reduce the chance of users copy-pasting real secrets into history and to be consistent with the cloud page.
Apply:
- --cluster-url="crate://user:[email protected]:4200/testdrive/demo" + --cluster-url="crate://<CRATEDB_USER>:<CRATEDB_PASSWORD>@cratedb.example.org:4200/testdrive/demo"docs/integrate/influxdb/cloud.md (1)
3-6: Grammar: “similar to” (not “similar like”).Tighten phrasing.
-The procedure for importing data from [InfluxDB Cloud] into [CrateDB Cloud] is -similar like the {ref}`standalone variant <influxdb-tutorial>`, with a few small -adjustments. +The procedure for importing data from [InfluxDB Cloud] into [CrateDB Cloud] is +similar to the {ref}`standalone variant <influxdb-tutorial>`, with a few small +adjustments.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
docs/integrate/influxdb/cloud.md(1 hunks)docs/integrate/influxdb/index.md(2 hunks)
🧰 Additional context used
🧠 Learnings (9)
📓 Common learnings
Learnt from: amotl
PR: crate/cratedb-guide#238
File: docs/integrate/azure-functions/learn.rst:1-1
Timestamp: 2025-08-09T16:19:43.966Z
Learning: In the CrateDB Guide documentation, main integration anchors (e.g., `azure-functions`) are intentionally placed in the `index.md` files of their respective integration folders, while detailed tutorials use the `-learn` suffix (e.g., `azure-functions-learn`) in their `learn.rst` or `learn.md` files. This is a deliberate architectural pattern for the documentation restructuring.
📚 Learning: 2025-08-08T16:50:14.965Z
Learnt from: amotl
PR: crate/cratedb-guide#234
File: docs/home/index.md:47-50
Timestamp: 2025-08-08T16:50:14.965Z
Learning: In the CrateDB Guide docs (MyST), the correct intersphinx target for the CrateDB Cloud documentation homepage is `cloud:index` (not `cloud:docs-index` or `cloud-docs-index`). Use `:link: cloud:index` on cards/links. The `cloud` mapping is inherited via crate-docs-theme.
Applied to files:
docs/integrate/influxdb/cloud.md
📚 Learning: 2025-05-18T12:50:36.393Z
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:22-33
Timestamp: 2025-05-18T12:50:36.393Z
Learning: In the CrateDB Guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/server`) is an intersphinx reference that points to external content in the CrateDB Toolkit documentation at https://cratedb-toolkit.readthedocs.io/. These references are intentionally not pointing to local files within the repository.
Applied to files:
docs/integrate/influxdb/cloud.md
📚 Learning: 2025-08-07T23:11:08.311Z
Learnt from: amotl
PR: crate/cratedb-guide#232
File: docs/_include/links.md:11-11
Timestamp: 2025-08-07T23:11:08.311Z
Learning: In the CrateDB Guide repository, intersphinx mappings like "cloud" are defined within the root project `crate-docs-theme` and inherited by the documentation projects, so they don't need to be explicitly defined in individual `docs/conf.py` files.
Applied to files:
docs/integrate/influxdb/cloud.md
📚 Learning: 2025-05-18T13:39:58.391Z
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/cratedb-mcp.md:3-8
Timestamp: 2025-05-18T13:39:58.391Z
Learning: In MyST Markdown, the correct syntax for rubric directives in the CrateDB documentation is:
```
:::{rubric} Title
:::
```
followed by the content outside of the directive. This is different from other admonition blocks where content is typically wrapped inside the directive.
Applied to files:
docs/integrate/influxdb/cloud.md
📚 Learning: 2025-08-09T21:40:46.154Z
Learnt from: amotl
PR: crate/cratedb-guide#238
File: docs/integrate/streamsets/index.md:18-21
Timestamp: 2025-08-09T21:40:46.154Z
Learning: In the CrateDB Guide documentation, reStructuredText files (`.rst`) use the RST label syntax `.. _label:` while MyST Markdown files (`.md`) use the syntax `(label)=`. Both formats are used throughout the repository and labels can be cross-referenced between them.
Applied to files:
docs/integrate/influxdb/cloud.md
📚 Learning: 2025-08-14T19:02:43.308Z
Learnt from: amotl
PR: crate/cratedb-guide#253
File: docs/integrate/mindsdb/index.md:21-33
Timestamp: 2025-08-14T19:02:43.308Z
Learning: In CrateDB integration documentation examples, default connection parameters (user="crate", password="", host="127.0.0.1") are intentionally used to provide working out-of-the-box examples for users with local CrateDB instances, rather than using placeholder values that require customization.
Applied to files:
docs/integrate/influxdb/cloud.md
📚 Learning: 2025-08-05T07:14:57.416Z
Learnt from: hammerhead
PR: crate/cratedb-guide#221
File: docs/connect/configure.md:58-66
Timestamp: 2025-08-05T07:14:57.416Z
Learning: In CrateDB connection strings, the user:password@ syntax is valid for HTTP Basic authentication on port 4200, but PostgreSQL JDBC drivers do not support this format and require credentials as query parameters (?user=<user>&password=<password>) instead.
Applied to files:
docs/integrate/influxdb/cloud.mddocs/integrate/influxdb/index.md
📚 Learning: 2025-06-05T14:29:15.512Z
Learnt from: amotl
PR: crate/cratedb-guide#207
File: docs/integrate/etl/iceberg-risingwave.md:205-207
Timestamp: 2025-06-05T14:29:15.512Z
Learning: The `records.Database("crate://", echo=True)` connection string for CrateDB works with defaults: localhost as host, "crate" as user, and blank password. This is valid and functional code in the records library.
Applied to files:
docs/integrate/influxdb/index.md
🪛 LanguageTool
docs/integrate/influxdb/cloud.md
[grammar] ~3-~3: There might be a mistake here.
Context: ...[InfluxDB Cloud] into [CrateDB Cloud] is similar like the {ref}`standalone varian...
(QB_NEW_EN)
[grammar] ~4-~4: There might be a mistake here.
Context: ...t `, with a few small adjustments. First, helpful aliases: ``...
(QB_NEW_EN)
[grammar] ~14-~14: There might be a mistake here.
Context: ...variables (recommended) to avoid leaking secrets in shell history. :::{rubric} C...
(QB_NEW_EN)
[grammar] ~17-~17: There might be a mistake here.
Context: ...hell history. :::{rubric} CrateDB Cloud ::: - Host: <CRATEDB_HOST> (e.g., `clu...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ... history. :::{rubric} CrateDB Cloud ::: - Host: <CRATEDB_HOST> (e.g., `cluster-i...
(QB_NEW_EN)
[grammar] ~19-~19: There might be a mistake here.
Context: ...ster-id.eks1.eu-west-1.aws.cratedb.net) - Username: <CRATEDB_USER>(e.g.,admin...
(QB_NEW_EN)
[grammar] ~20-~20: There might be a mistake here.
Context: ...ername: <CRATEDB_USER> (e.g., admin) - Password: <CRATEDB_PASSWORD> :::{rubr...
(QB_NEW_EN)
[grammar] ~23-~23: There might be a mistake here.
Context: ...B_PASSWORD> :::{rubric} InfluxDB Cloud ::: - Host:<INFLUXDB_HOST>(e.g.,eu...
(QB_NEW_EN)
[grammar] ~24-~24: There might be a mistake here.
Context: ...SSWORD> :::{rubric} InfluxDB Cloud ::: - Host:<INFLUXDB_HOST>(e.g.,eu-centr...
(QB_NEW_EN)
[grammar] ~25-~25: There might be a mistake here.
Context: ...-central-1-1.aws.cloud2.influxdata.com) - Organization ID: <INFLUXDB_ORG_ID>` - A...
(QB_NEW_EN)
[grammar] ~26-~26: There might be a mistake here.
Context: ...ud2.influxdata.com) - Organization ID: <INFLUXDB_ORG_ID>- All-Access API token:<INFLUXDB_TOKEN>`...
(QB_NEW_EN)
[grammar] ~29-~29: There might be a mistake here.
Context: ... CrateDB, the credentials are displayed at time of cluster creation. For InfluxDB,...
(QB_NEW_EN)
[grammar] ~29-~29: There might be a mistake here.
Context: ...e displayed at time of cluster creation. For InfluxDB, they can be found in the [...
(QB_NEW_EN)
[grammar] ~32-~32: There might be a mistake here.
Context: ...self. Now, same as before, import data from InfluxDB bucket/measurement into Crate...
(QB_NEW_EN)
[grammar] ~41-~41: There might be a mistake here.
Context: .../testdrive/demo?ssl=true" ``` :::{note} Note the necessary ssl=true query ...
(QB_NEW_EN)
[grammar] ~42-~42: There might be a mistake here.
Context: ...the end of both database connection URLs when working on Cloud-to-Cloud transfers...
(QB_NEW_EN)
[grammar] ~43-~43: There might be a mistake here.
Context: ...hen working on Cloud-to-Cloud transfers. ::: Verify that relevant data has been ...
(QB_NEW_EN)
docs/integrate/influxdb/index.md
[grammar] ~65-~65: There might be a mistake here.
Context: ...th: 1 :hidden: Tutorial cloud model ::: :::{note} The InfluxDB I/O s...
(QB_NEW_EN)
[grammar] ~66-~66: There might be a mistake here.
Context: ...:hidden: Tutorial cloud model ::: :::{note} The InfluxDB I/O subsyst...
(QB_NEW_EN)
🔇 Additional comments (6)
docs/integrate/influxdb/index.md (4)
61-67: Toctree additions look good.Adding “cloud” and “model” under the Tutorial toctree is coherent with the restructuring.
70-73: Good addition: reference to influxio.Linking the I/O subsystem to influxio with a MyST note and footnote link is helpful and accurate.
46-51: Reference verified:influxdb-tutorialis defined
- The link label
(influxdb-tutorial)=is present at line 1 ofdocs/integrate/influxdb/tutorial.md. No further action needed.
31-34:--cluster-urlis the correct, current CLI flag forctk load table
Verified against the official cratedb-toolkit documentation and changelog: the previous--cratedb-sqlalchemy-urloption has been deprecated and converged into--cluster-url. No changes required.docs/integrate/influxdb/cloud.md (2)
13-28: Nice switch to placeholders and env var guidance.Good call-outs with rubric sections and consistent placeholder naming for CrateDB and InfluxDB credentials.
3-6: Cross-reference and CTK flag verified
- The
(influxdb-tutorial)=label is defined in docs/integrate/influxdb/tutorial.md and will resolve correctly.- The CTK load table flag
--cluster-urlis the correct option and is used consistently in cloud.md (and across all InfluxDB docs).No changes needed.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
docs/integrate/influxdb/cloud.md (1)
35-38: Fix env var name mismatches in the load command (will fail as written).The command uses INFLUX_ORG and INFLUX_HOST, but the bullets define INFLUXDB_ORG_ID and INFLUXDB_HOST. Align them to avoid runtime errors.
ctk load table \ - "influxdb2://${INFLUX_ORG}:${INFLUX_TOKEN}@${INFLUX_HOST}/testdrive/demo?ssl=true" \ + "influxdb2://${INFLUXDB_ORG_ID}:${INFLUXDB_TOKEN}@${INFLUXDB_HOST}/testdrive/demo?ssl=true" \ --cluster-url="crate://${CRATEDB_USER}:${CRATEDB_PASSWORD}@${CRATEDB_HOST}:4200/testdrive/demo?ssl=true"
🧹 Nitpick comments (6)
docs/integrate/influxdb/model.md (2)
1-1: Add a label for cross-referencing this page.Adding a MyST label keeps cross-references stable across refactors and matches the guide’s conventions.
-# Data Model +(influxdb-data-model)= +# Data Model
3-4: Tighten phrasing; combine into one sentence.Minor style fix; reads smoother and addresses the grammar hint.
-InfluxDB stores time-series data in buckets and measurements. CrateDB stores -data in schemas and tables. +InfluxDB stores time-series data in buckets and measurements; CrateDB stores data in schemas and tables.docs/integrate/influxdb/cloud.md (4)
3-5: Grammar: “similar to”, not “similar like”.Small copy edit for correctness.
-The procedure for importing data from [InfluxDB Cloud] into [CrateDB Cloud] is -similar like the {ref}`standalone variant <influxdb-tutorial>`, with a few small +The procedure for importing data from [InfluxDB Cloud] into [CrateDB Cloud] is +similar to the {ref}`standalone variant <influxdb-tutorial>`, with a few small adjustments.
9-10: Optionally pin the toolkit image for reproducibility.Using a tagged image instead of “latest” avoids surprises when the image updates.
-alias ctk="docker run --rm -it ghcr.io/crate/cratedb-toolkit:latest ctk" -alias crash="docker run --rm -it ghcr.io/crate/cratedb-toolkit:latest crash" +alias ctk="docker run --rm -it ghcr.io/crate/cratedb-toolkit:<tag> ctk" +alias crash="docker run --rm -it ghcr.io/crate/cratedb-toolkit:<tag> crash"Replace with a known-good release.
29-33: Add a short env var setup snippet (helps users copy-paste successfully).This complements the placeholders and reduces friction for first-time runs.
For CrateDB, the credentials are displayed at time of cluster creation. For InfluxDB, they can be found in the [cloud platform] itself. +Example environment variable setup: + +```shell +export CRATEDB_HOST='<CRATEDB_HOST>' +export CRATEDB_USER='<CRATEDB_USER>' +export CRATEDB_PASSWORD='<CRATEDB_PASSWORD>' + +export INFLUXDB_HOST='<INFLUXDB_HOST>' +export INFLUXDB_ORG_ID='<INFLUXDB_ORG_ID>' +export INFLUXDB_TOKEN='<INFLUXDB_TOKEN>' +``` + Now, same as before, import data from InfluxDB bucket/measurement into CrateDB schema/table.If you prefer, I can add OS-specific guidance or a .env example.
45-48: Limit result size in verification query (friendlier output).Selecting all rows can be noisy on large datasets. Consider a limit.
-crash --hosts "https://${CRATEDB_USER}:${CRATEDB_PASSWORD}@${CRATEDB_HOST}:4200" --command 'SELECT * FROM testdrive.demo;' +crash --hosts "https://${CRATEDB_USER}:${CRATEDB_PASSWORD}@${CRATEDB_HOST}:4200" --command 'SELECT * FROM testdrive.demo LIMIT 5;'Alternatively, show a quick count: SELECT count(*) FROM testdrive.demo;
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
docs/integrate/influxdb/cloud.md(1 hunks)docs/integrate/influxdb/model.md(1 hunks)
🧰 Additional context used
🧠 Learnings (6)
📓 Common learnings
Learnt from: amotl
PR: crate/cratedb-guide#238
File: docs/integrate/azure-functions/learn.rst:1-1
Timestamp: 2025-08-09T16:19:43.966Z
Learning: In the CrateDB Guide documentation, main integration anchors (e.g., `azure-functions`) are intentionally placed in the `index.md` files of their respective integration folders, while detailed tutorials use the `-learn` suffix (e.g., `azure-functions-learn`) in their `learn.rst` or `learn.md` files. This is a deliberate architectural pattern for the documentation restructuring.
📚 Learning: 2025-05-18T13:39:58.391Z
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/cratedb-mcp.md:3-8
Timestamp: 2025-05-18T13:39:58.391Z
Learning: In MyST Markdown, the correct syntax for rubric directives in the CrateDB documentation is:
```
:::{rubric} Title
:::
```
followed by the content outside of the directive. This is different from other admonition blocks where content is typically wrapped inside the directive.
Applied to files:
docs/integrate/influxdb/cloud.md
📚 Learning: 2025-08-09T21:40:46.154Z
Learnt from: amotl
PR: crate/cratedb-guide#238
File: docs/integrate/streamsets/index.md:18-21
Timestamp: 2025-08-09T21:40:46.154Z
Learning: In the CrateDB Guide documentation, reStructuredText files (`.rst`) use the RST label syntax `.. _label:` while MyST Markdown files (`.md`) use the syntax `(label)=`. Both formats are used throughout the repository and labels can be cross-referenced between them.
Applied to files:
docs/integrate/influxdb/cloud.md
📚 Learning: 2025-08-15T18:56:11.233Z
Learnt from: amotl
PR: crate/cratedb-guide#255
File: docs/integrate/influxdb/tutorial.md:120-123
Timestamp: 2025-08-15T18:56:11.233Z
Learning: In CrateDB integration tutorials, when using `ctk load table` with `--cluster-url="crate://userhost:port/schema/table"`, the verification query should reference the target schema.table combination specified in the cluster URL, not derive it from the source system's naming. For example, if loading from InfluxDB bucket/measurement `testdrive/demo` to CrateDB `doc/testdrive`, the verification query should be `SELECT * FROM doc.testdrive`.
Applied to files:
docs/integrate/influxdb/cloud.md
📚 Learning: 2025-08-14T19:02:43.308Z
Learnt from: amotl
PR: crate/cratedb-guide#253
File: docs/integrate/mindsdb/index.md:21-33
Timestamp: 2025-08-14T19:02:43.308Z
Learning: In CrateDB integration documentation examples, default connection parameters (user="crate", password="", host="127.0.0.1") are intentionally used to provide working out-of-the-box examples for users with local CrateDB instances, rather than using placeholder values that require customization.
Applied to files:
docs/integrate/influxdb/cloud.md
📚 Learning: 2025-08-05T07:14:57.416Z
Learnt from: hammerhead
PR: crate/cratedb-guide#221
File: docs/connect/configure.md:58-66
Timestamp: 2025-08-05T07:14:57.416Z
Learning: In CrateDB connection strings, the user:password@ syntax is valid for HTTP Basic authentication on port 4200, but PostgreSQL JDBC drivers do not support this format and require credentials as query parameters (?user=<user>&password=<password>) instead.
Applied to files:
docs/integrate/influxdb/cloud.md
🪛 LanguageTool
docs/integrate/influxdb/cloud.md
[grammar] ~3-~3: There might be a mistake here.
Context: ...[InfluxDB Cloud] into [CrateDB Cloud] is similar like the {ref}`standalone varian...
(QB_NEW_EN)
[grammar] ~4-~4: There might be a mistake here.
Context: ...t `, with a few small adjustments. First, helpful aliases: ``...
(QB_NEW_EN)
[grammar] ~14-~14: There might be a mistake here.
Context: ...variables (recommended) to avoid leaking secrets in shell history. :::{rubric} C...
(QB_NEW_EN)
[grammar] ~17-~17: There might be a mistake here.
Context: ...hell history. :::{rubric} CrateDB Cloud ::: - Host: <CRATEDB_HOST> (e.g., `clu...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ... history. :::{rubric} CrateDB Cloud ::: - Host: <CRATEDB_HOST> (e.g., `cluster-i...
(QB_NEW_EN)
[grammar] ~19-~19: There might be a mistake here.
Context: ...ster-id.eks1.eu-west-1.aws.cratedb.net) - Username: <CRATEDB_USER>(e.g.,admin...
(QB_NEW_EN)
[grammar] ~20-~20: There might be a mistake here.
Context: ...ername: <CRATEDB_USER> (e.g., admin) - Password: <CRATEDB_PASSWORD> :::{rubr...
(QB_NEW_EN)
[grammar] ~23-~23: There might be a mistake here.
Context: ...B_PASSWORD> :::{rubric} InfluxDB Cloud ::: - Host:<INFLUXDB_HOST>(e.g.,eu...
(QB_NEW_EN)
[grammar] ~24-~24: There might be a mistake here.
Context: ...SSWORD> :::{rubric} InfluxDB Cloud ::: - Host:<INFLUXDB_HOST>(e.g.,eu-centr...
(QB_NEW_EN)
[grammar] ~25-~25: There might be a mistake here.
Context: ...-central-1-1.aws.cloud2.influxdata.com) - Organization ID: <INFLUXDB_ORG_ID>` - A...
(QB_NEW_EN)
[grammar] ~26-~26: There might be a mistake here.
Context: ...ud2.influxdata.com) - Organization ID: <INFLUXDB_ORG_ID>- All-Access API token:<INFLUXDB_TOKEN>`...
(QB_NEW_EN)
[grammar] ~29-~29: There might be a mistake here.
Context: ... CrateDB, the credentials are displayed at time of cluster creation. For InfluxDB,...
(QB_NEW_EN)
[grammar] ~29-~29: There might be a mistake here.
Context: ...e displayed at time of cluster creation. For InfluxDB, they can be found in the [...
(QB_NEW_EN)
[grammar] ~32-~32: There might be a mistake here.
Context: ...self. Now, same as before, import data from InfluxDB bucket/measurement into Crate...
(QB_NEW_EN)
[grammar] ~40-~40: There might be a mistake here.
Context: .../testdrive/demo?ssl=true" ``` :::{note} Note the necessary ssl=true query ...
(QB_NEW_EN)
[grammar] ~41-~41: There might be a mistake here.
Context: ...the end of both database connection URLs when working on Cloud-to-Cloud transfers...
(QB_NEW_EN)
[grammar] ~42-~42: There might be a mistake here.
Context: ...hen working on Cloud-to-Cloud transfers. ::: Verify that relevant data has been ...
(QB_NEW_EN)
docs/integrate/influxdb/model.md
[grammar] ~3-~3: There might be a mistake here.
Context: ...buckets and measurements. CrateDB stores data in schemas and tables. - A **bucke...
(QB_NEW_EN)
🔇 Additional comments (4)
docs/integrate/influxdb/model.md (1)
7-11: Series definition is now correct.Good correction: series are defined by measurement and tag set; fields do not affect series cardinality. The SQL analogies for measurement/tag/field/point are concise and accurate.
docs/integrate/influxdb/cloud.md (3)
13-22: Good use of placeholders and MyST rubric.Clear placeholders and rubric syntax align with doc conventions and avoid leaking secrets.
23-28: InfluxDB credentials section looks good.Consistent placeholder naming and scoping. Nice.
40-43: SSL note is clear and necessary.Good emphasis on the ssl=true requirement for both URLs in Cloud-to-Cloud.
2 participants
About
The goal is to present concise walkthroughs without many bells and whistles, which get to the point of getting you started quickly.
Details
The content now uses the established template for the starter tutorial in
tutorial.md. What's different here is that the backbone section also includes two separate files now, one educating about InfluxDB's data model, and the other one specifically educating about usage in Cloud environments.Preview
https://cratedb-guide--255.org.readthedocs.build/integrate/influxdb/tutorial.html