Add cr suggestion and update older docs links
This commit is contained in:
parent
50abe23e4d
commit
5a341aad79
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
A Batch Query enables you to request queries with long-running CPU processing times. Typically, these kind of requests raise timeout errors when using the SQL API. In order to avoid timeouts, you can use Batch Queries to [create](#create-a-job), [read](#read-a-job) and [cancel](#cancel-a-job) queries. You can also run a [chained batch query](#chaining-batch-queries) to chain several SQL queries into one job. A Batch Query schedules the incoming jobs and allows you to request the job status for each query.
|
A Batch Query enables you to request queries with long-running CPU processing times. Typically, these kind of requests raise timeout errors when using the SQL API. In order to avoid timeouts, you can use Batch Queries to [create](#create-a-job), [read](#read-a-job) and [cancel](#cancel-a-job) queries. You can also run a [chained batch query](#chaining-batch-queries) to chain several SQL queries into one job. A Batch Query schedules the incoming jobs and allows you to request the job status for each query.
|
||||||
|
|
||||||
_Batch Queries are not intended to be used for large query payloads that contain over 16384 characters (16kb). For instance, if you are inserting a large number of rows into your table, you still need to use the [Import API](https://carto.com/docs/carto-engine/import-api/) or [SQL API]({{ site.sqlapi_docs }}/guides/) for this type of data management. Batch Queries are specific to queries and CPU usage._
|
_Batch Queries are not intended to be used for large query payloads that contain over 16384 characters (16kb). For instance, if you are inserting a large number of rows into your table, you still need to use the [Import API]({{site.importapi_docs}}/) or [SQL API]({{site.sqlapi_docs}}/guides/) for this type of data management. Batch Queries are specific to queries and CPU usage._
|
||||||
|
|
||||||
**Note:** SQL API does not expose any endpoint to list Batch Queries (jobs). Thus, when creating a Batch Query (job), you must always save the ID from the response, as the main reference for any later operation.
|
**Note:** SQL API does not expose any endpoint to list Batch Queries (jobs). Thus, when creating a Batch Query (job), you must always save the ID from the response, as the main reference for any later operation.
|
||||||
|
|
||||||
@ -487,7 +487,7 @@ For best practices, follow these recommended usage notes when using Batch Querie
|
|||||||
|
|
||||||
- Batch Queries are recommended for INSERT, UPDATE, and CREATE queries that manipulate and create new data, such as creating expensive indexes, applying updates over large tables, and creating tables from complex queries. Batch queries have no effect for SELECT queries that retrieve data but do not store the results in a table. For example, running a batch query using `SELECT * from my_dataset` will not produce any results.
|
- Batch Queries are recommended for INSERT, UPDATE, and CREATE queries that manipulate and create new data, such as creating expensive indexes, applying updates over large tables, and creating tables from complex queries. Batch queries have no effect for SELECT queries that retrieve data but do not store the results in a table. For example, running a batch query using `SELECT * from my_dataset` will not produce any results.
|
||||||
|
|
||||||
- Batch Queries are not intended for large query payloads (e.g: inserting thousands of rows), use the [Import API](https://carto.com/docs/carto-engine/import-api/) for this type of data management.
|
- Batch Queries are not intended for large query payloads (e.g: inserting thousands of rows), use the [Import API]({{site.importapi_docs}}/) for this type of data management.
|
||||||
|
|
||||||
- There is a limit of 16kb per job. The following error message appears if your job exceeds this size:
|
- There is a limit of 16kb per job. The following error message appears if your job exceeds this size:
|
||||||
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
## Metrics
|
## Metrics
|
||||||
|
|
||||||
SQL API provides you with a set of operations to handle metrics. You are able to manage timers operations that allow you to analyze your queries, and counters operations that allow you to meaure success and failed queries.
|
SQL API provides you with a set of operations to handle metrics. You are able to manage timer operations that allow you to analyze the time spent in your queries, and counter operations that allow you to measure the number of successful and failed queries.
|
||||||
|
|
||||||
### Timers
|
### Timers
|
||||||
- **sqlapi.query**: time to return a query resultset from the API, splitted into:
|
- **sqlapi.query**: time to return a query resultset from the API, splitted into:
|
||||||
|
@ -37,7 +37,7 @@ https://{username}.carto.com/api/v2/sql?q=SELECT count(*) FROM {table_name}
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Finally, remember that in order to use the SQL API, either your table must be public, or you must be [authenticated](http://docs.carto.com/carto-engine/sql-api/authentication/#authentication) using API Keys.
|
Finally, remember that in order to use the SQL API, either your table must be public, or you must be [authenticated]({{site.sqlapi_docs}}/guides/authentication/#authentication) using API Keys.
|
||||||
|
|
||||||
|
|
||||||
### POST and GET
|
### POST and GET
|
||||||
|
@ -42,7 +42,7 @@ Yes, through using GRANT statements to the SQL API. There are a few caveats to b
|
|||||||
|
|
||||||
You can use the SQL API to run any query and export the results in different formats, such as a CSV or GeoPackage. This is helpful for accessing your datasets offline.
|
You can use the SQL API to run any query and export the results in different formats, such as a CSV or GeoPackage. This is helpful for accessing your datasets offline.
|
||||||
|
|
||||||
**Note:** View the [response formats]({{ site.sqlapi_docs }}/guides/making-calls/#response-formats) that are available with the SQL API and ensure that your dataset does not exceed the maximum file size for [SQL API exports](https://carto.com/docs/faqs/carto-engine-usage-limits/#sql-api-limits).
|
**Note:** View the [response formats]({{ site.sqlapi_docs }}/guides/making-calls/#response-formats) that are available with the SQL API and ensure that your dataset does not exceed the maximum file size for [SQL API exports](https://carto.com/help/getting-started/limits/#sql-api-limits).
|
||||||
|
|
||||||
#### Export Datasets as a GeoPackage
|
#### Export Datasets as a GeoPackage
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user