Merge pull request #126 from HarperDB/sql-warnings

Add warning to the top of SQL pages
HarperDB · Nov 19, 2024 · e7aff7f · e7aff7f
2 parents 1fcbfdc + 950770d
commit e7aff7f
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 0 deletions.
diff --git a/docs/developers/operations-api/sql-operations.md b/docs/developers/operations-api/sql-operations.md
@@ -1,3 +1,7 @@
+{% hint style="warning" %}
+HarperDB encourages developers to utilize other querying tools over SQL for performance purposes. HarperDB SQL is intended for data investigation purposes and uses cases where performance is not a priority. SQL optimizations are on our roadmap for the future.
+{% endhint %}
+
 # SQL Operations 
 
 ## Select

diff --git a/docs/developers/sql-guide/date-functions.md b/docs/developers/sql-guide/date-functions.md
@@ -1,3 +1,7 @@
+{% hint style="warning" %}
+HarperDB encourages developers to utilize other querying tools over SQL for performance purposes. HarperDB SQL is intended for data investigation purposes and uses cases where performance is not a priority. SQL optimizations are on our roadmap for the future.
+{% endhint %}
+
 # SQL Date Functions
 
 HarperDB utilizes [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time) in all internal SQL operations. This means that date values passed into any of the functions below will be assumed to be in UTC or in a format that can be translated to UTC.

diff --git a/docs/developers/sql-guide/features-matrix.md b/docs/developers/sql-guide/features-matrix.md
@@ -1,3 +1,7 @@
+{% hint style="warning" %}
+HarperDB encourages developers to utilize other querying tools over SQL for performance purposes. HarperDB SQL is intended for data investigation purposes and uses cases where performance is not a priority. SQL optimizations are on our roadmap for the future.
+{% endhint %}
+
 # SQL Features Matrix
 
 HarperDB provides access to most SQL functions, and we’re always expanding that list. Check below to see if we cover what you need. If not, feel free to [add a Feature Request](https://feedback.harperdb.io/).

diff --git a/docs/developers/sql-guide/functions.md b/docs/developers/sql-guide/functions.md
@@ -1,3 +1,7 @@
+{% hint style="warning" %}
+HarperDB encourages developers to utilize other querying tools over SQL for performance purposes. HarperDB SQL is intended for data investigation purposes and uses cases where performance is not a priority. SQL optimizations are on our roadmap for the future.
+{% endhint %}
+
 # HarperDB SQL Functions
 
 This SQL keywords reference contains the SQL functions available in HarperDB.

diff --git a/docs/developers/sql-guide/json-search.md b/docs/developers/sql-guide/json-search.md
@@ -1,3 +1,7 @@
+{% hint style="warning" %}
+HarperDB encourages developers to utilize other querying tools over SQL for performance purposes. HarperDB SQL is intended for data investigation purposes and uses cases where performance is not a priority. SQL optimizations are on our roadmap for the future.
+{% endhint %}
+
 # SQL JSON Search
 
 HarperDB automatically indexes all top level attributes in a row / object written to a table. However, any attributes which hold JSON data do not have their nested attributes indexed. In order to make searching and/or transforming these JSON documents easy, HarperDB offers a special SQL function called SEARCH\_JSON. The SEARCH\_JSON function works in SELECT & WHERE clauses allowing queries to perform powerful filtering on any element of your JSON by implementing the [JSONata library](http://docs.jsonata.org/overview.html) into our SQL engine.

diff --git a/docs/developers/sql-guide/reserved-word.md b/docs/developers/sql-guide/reserved-word.md
@@ -1,3 +1,7 @@
+{% hint style="warning" %}
+HarperDB encourages developers to utilize other querying tools over SQL for performance purposes. HarperDB SQL is intended for data investigation purposes and uses cases where performance is not a priority. SQL optimizations are on our roadmap for the future.
+{% endhint %}
+
 # HarperDB SQL Reserved Words
 
 This is a list of reserved words in the SQL Parser.  Use of these words or symbols may result in unexpected behavior or inaccessible tables/attributes.  If any of these words must be used, any SQL call referencing a database, table, or attribute must have backticks (`…`) or brackets ([…]) around the variable.

diff --git a/docs/developers/sql-guide/sql-geospatial-functions.md b/docs/developers/sql-guide/sql-geospatial-functions.md
@@ -1,3 +1,7 @@
+{% hint style="warning" %}
+HarperDB encourages developers to utilize other querying tools over SQL for performance purposes. HarperDB SQL is intended for data investigation purposes and uses cases where performance is not a priority. SQL optimizations are on our roadmap for the future.
+{% endhint %}
+
 # SQL Geospatial Functions
 
 HarperDB geospatial features require data to be stored in a single column using the [GeoJSON standard](http://geojson.org/), a standard commonly used in geospatial technologies. Geospatial functions are available to be used in SQL statements.