Skip to content

Document N-dimensional arrays #160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Document N-dimensional arrays #160

wants to merge 8 commits into from

Conversation

mtopolnik
Copy link
Contributor

No description provided.

@mtopolnik mtopolnik requested review from nwoolmer and Copilot March 28, 2025 12:18
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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, and array) 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)`

Copy link

github-actions bot commented Mar 28, 2025

🚀 Build success!

Latest successful preview: https://preview-160--questdb-documentation.netlify.app

Commit SHA: 91f1a53

📦 Build generates a preview & updates link on each commit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants