Document N-dimensional arrays #160
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the documentation by introducing detailed information on QuestDB's support for N-dimensional arrays and updates related type definitions and function signatures. Key changes include:
- Adding a new section describing the N-dimensional array type with visual examples and detailed explanation of its layout.
- Updating type definitions in the SQL reference (e.g., for
date,interval, andarray) with clearer annotations. - Revising the function documentation for l2price to reflect new parameter names and variants for array-based and scalar inputs.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| documentation/reference/sql/datatypes.md | Clarified type definitions and added documentation for the N-dimensional array type. |
| documentation/reference/operators/numeric.md | Added a note indicating that numeric operators support N-dimensional array operations. |
| documentation/reference/function/finance.md | Updated the l2price function signature and examples to use new parameter names and variants. |
Comments suppressed due to low confidence (2)
documentation/reference/sql/datatypes.md:29
- [nitpick] Consider clarifying the header size calculation by explicitly stating that 'nDims' represents the number of dimensions and confirming the units (bytes) used in the formula.
| `array` | See description | Yes | Header: 20 + 4 * `nDims` bytes. Payload: dense array of values. Example: `DOUBLE[3][4]`: header 28 bytes, payload 3*4*8 = 96 bytes.
documentation/reference/function/finance.md:13
- [nitpick] Ensure that the naming of parameters ('target_size', 'size_array', and 'price_array') is consistent with the scalar variant and clearly conveys their purpose.
`l2price(target_size, size_array, price_array)`
|
🚀 Build success! Latest successful preview: https://preview-160--questdb-documentation.netlify.app/docs/ Commit SHA: 00d8d6f
|
|
It seems the array concept page is not linked from the left menu. Also, the layout of the concept page is missing the navigation menu altogether. I also found a bit lacking the docs (not sure if on concepts, data types, or both) about how to use an array as literal. I only could see an example on the finance functions page, which is good, but I would expect to see that also in the pages introducing arrays |
|
Functions like matmul, transpose, flatten, or dim_length are not available on the functions reference. Guess we need a new page for Array functions |
... so they don't show up in contents
No description provided.