docs: Add a note on placeholders in a generated query

cube-js · Dec 19, 2024 · e1911d4 · e1911d4
1 parent 04deee9
commit e1911d4
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/docs/pages/product/workspace/playground.mdx b/docs/pages/product/workspace/playground.mdx
@@ -156,6 +156,13 @@ on the <Btn>Generated SQL</Btn> tab. Click <Btn>Copy</Btn> to put it into your c
   src="https://ucarecdn.com/d2b6e514-9219-49ea-bae6-bcd0f1936542/"
 />
 
+<InfoBox>
+
+Note that a generated query can contain placeholders, e.g., `?` or `$1`, for parameters
+that Cube passes to an underlying data source driver later when executing the query.
+
+</InfoBox>
+
 ## Copying API queries
 
 View the queries for respective data APIs on the <Btn>SQL API</Btn>, <Btn>REST API</Btn>,

diff --git a/docs/pages/reference/rest-api.mdx b/docs/pages/reference/rest-api.mdx
@@ -145,6 +145,13 @@ Example response:
 }
 ```
 
+<InfoBox>
+
+Note that a generated query can contain placeholders, e.g., `?` or `$1`, for parameters
+that Cube passes to an underlying data source driver later when executing the query.
+
+</InfoBox>
+
 ## `/v1/meta`
 
 Get meta-information for cubes and views defined in the data model. Information about cubes and views with `public: false` will not be returned.