Inventory: Add more relevant general and specific information#41
Conversation
- partitioned tables
- column storage
- replication
- `{CREATE,ALTER} [FOREIGN] TABLE`
- `COPY {FROM,TO}`
WalkthroughThis update reorganizes and expands the CrateDB documentation outline by adding new reference and guide entries, particularly for partitioned tables, storage, replication, views, SQL commands, and data types. It also introduces instructions for importing example datasets and updates the changelog and backlog to reflect these documentation enhancements. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant DocsOutline
participant ReferenceDocs
participant ExamplesSection
User->>DocsOutline: Access documentation outline
DocsOutline->>ReferenceDocs: Display new entries (Partitioned tables, Storage, Replication, Views, SQL commands, Data types)
DocsOutline->>ExamplesSection: Show "Import example datasets" instructions
User->>ReferenceDocs: Navigate to detailed guides
User->>ExamplesSection: Follow dataset import instructions
Possibly related PRs
Suggested reviewers
Poem
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Note ⚡️ Faster reviews with cachingCodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
🔇 Additional comments (5)
✨ 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. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/backlog.md (1)
43-44: Backlog: Add missing inventory items for SQL data types and example datasets.The new “Done” entry tracks DDL/views and COPY support but omits tasks for SQL data types and importing example datasets via the CrateDB Toolkit (both of which are covered in this PR).
Consider adding separate backlog items to reflect those completed tasks for completeness and traceability.src/cratedb_about/outline/cratedb-outline.yaml (1)
648-658: Examples: Correct the inline comment URL.The comment above the “Import example datasets” entry still points to the cluster documentation. Update or remove the comment to reference the datasets page (e.g.,
https://cratedb-toolkit.readthedocs.io/datasets.html) to avoid confusion.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
CHANGES.md(1 hunks)docs/backlog.md(1 hunks)src/cratedb_about/outline/cratedb-outline.yaml(4 hunks)
🔇 Additional comments (5)
src/cratedb_about/outline/cratedb-outline.yaml (4)
197-231: General information: Approve partitioned tables, storage, replication, and views entries.The new reference items for partitioned tables, column storage, replication, and views are well-structured, include both
linkandhtmlfields, and correctly reference thereferenceparent. This fills a major gap in the outline.
246-261: Performance guidelines: Approve relocated section.The “Performance guidelines” block has been moved to follow “Data modeling,” matching the AI summary and improving logical grouping of related guides.
381-432: SQL: Commands: Approve new command references.The additions under “# SQL: Commands” cover key DDL and data-loading statements (
CREATE TABLE,ALTER TABLE,COPY FROM/TO, etc.). Entry metadata (links, HTML, parents, tags) is consistent with existing patterns.
433-444: SQL: Data types: Approve new entry.The “Data types” reference is correctly added under
sql-syntax, with proper link, HTML URL, description, parents, and[ sql ]tag.CHANGES.md (1)
5-9: CHANGES: Approve new Inventory entries.The changelog correctly documents the addition of general info on partitioned tables, storage, replication, views, SQL commands (
CREATE,ALTER,COPY), SQL data types, and example-dataset import via the CrateDB Toolkit.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
src/cratedb_about/outline/cratedb-outline.yaml (2)
208-215: Fix minor grammatical issue in Storage description.
The phrase “in conjunction of turning off indexing” should read “in conjunction with turning off indexing” for clarity and correctness.- Turning off the Column Store in conjunction of turning off indexing will remove the length limitation. + Turning off the Column Store in conjunction with turning off indexing will remove the length limitation.
381-431: Consider reordering CREATE FOREIGN TABLE in the SQL Commands list.
For logical consistency, group all CREATE statements together before ALTER and COPY commands. For example:# SQL: Commands - CREATE TABLE - CREATE TABLE AS - CREATE FOREIGN TABLE ← move here - ALTER TABLE - COPY FROM - COPY TO
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/backlog.md(1 hunks)src/cratedb_about/outline/cratedb-outline.yaml(4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/backlog.md
🔇 Additional comments (6)
src/cratedb_about/outline/cratedb-outline.yaml (6)
197-207: Approve addition of Partitioned Tables reference entry.
The description clearly explains partitioned tables, links are accurate, and placement before “Data modeling” follows the intended outline structure.
216-223: Approve addition of Replication reference entry.
The replication entry accurately describes table replication behavior, the links are correct, andparents: [ reference ]is consistent with other reference docs.
224-231: Approve addition of Views reference entry.
The views entry succinctly covers stored queries and privilege nuances; links and hierarchy are spot on.
246-261: Approve grouping under new “Performance guidelines” section.
Relocating the sharding, query optimization, and scaling guides into their own section enhances discoverability and aligns with the reorganized outline.
433-443: Approve addition of SQL Data Types reference entry.
This entry comprehensively covers the role of data types in CrateDB, and the provided links and hierarchy are correct.
648-657: Approve addition of Toolkit Example Datasets entry.
This new example aligns perfectly with the PR objectives, and the description correctly highlights thecratedb_toolkit.datasets.load_datasetAPI usage.
3e3a8da to
596ee08
Compare
| A partition is similar to a regular single table and consists of one or more shards. | ||
| A table becomes a partitioned table by defining partition columns. | ||
| When a record with a new distinct combination of values for the configured partition | ||
| columns is inserted, a new partition is created and the document will be inserted into this partition. |
There was a problem hiding this comment.
| columns is inserted, a new partition is created and the document will be inserted into this partition. | |
| columns is inserted, a new partition is created, and the document is inserted into this new partition. |
About
When curating the outline/index, we found a few important items to be missing, that should to be considered for an essential CrateDB knowledge base and as convenient utility sidekick when conceiving tutorials about CrateDB.
Details
{CREATE,ALTER} [FOREIGN] TABLE [AS]COPY {FROM,TO}cratedb_toolkit.datasets.load_datasetAPI/cc @surister, @kneth, @bmunkholm