Skip to content

Commit c2221b1

Browse files
nwoolmernwoolmer
committed
some edits
1 parent 8b6a9bc commit c2221b1

File tree

3 files changed

+105
-120
lines changed

3 files changed

+105
-120
lines changed

‎documentation/reference/api/rest.md‎

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -590,27 +590,27 @@ returned in a tabular form to be saved and reused as opposed to JSON.
590590

591591
`/exp` is expecting an HTTP GET request with following parameters:
592592

593-
| Parameter | Required | Description |
594-
| :--------------------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
595-
| `query` | Yes | URL encoded query text. It can be multi-line. |
596-
| `limit` | No | Paging opp parameter. For example, `limit=10,20` will return row numbers 10 through to 20 inclusive and `limit=20` will return first 20 rows, which is equivalent to `limit=0,20`. `limit=-20` will return the last 20 rows. |
597-
| `nm` | No | `true` or `false`. Skips the metadata section of the response when set to `true`. |
598-
| `fmt` | No | Export format. Valid values: `parquet`. When set to `parquet`, exports data in Parquet format instead of CSV. |
593+
| Parameter | Required | Description |
594+
|:----------|:---------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
595+
| `query` | Yes | URL encoded query text. It can be multi-line. |
596+
| `limit` | No | Paging opp parameter. For example, `limit=10,20` will return row numbers 10 through to 20 inclusive and `limit=20` will return first 20 rows, which is equivalent to `limit=0,20`. `limit=-20` will return the last 20 rows. |
597+
| `nm` | No | `true` or `false`. Skips the metadata section of the response when set to `true`. |
598+
| `fmt` | No | Export format. Valid values: `parquet`, `csv`. When set to `parquet`, exports data in Parquet format instead of CSV. |
599599

600600
#### Parquet Export Parameters
601601

602602
When `fmt=parquet`, the following additional parameters are supported:
603603

604-
| Parameter | Required | Default | Description |
605-
| :--------------------- | :------- | :----------- | :-------------------------------------------------------------------------------------------------------------- |
606-
| `partition_by` | No | `NONE` | Partition unit: `NONE`, `HOUR`, `DAY`, `WEEK`, `MONTH`, or `YEAR`. |
607-
| `compression_codec` | No | `ZSTD` | Compression algorithm: `UNCOMPRESSED`, `SNAPPY`, `GZIP`, `LZ4`, `ZSTD`, or `LZ4_RAW`. |
608-
| `compression_level` | No | Codec-dependent | Compression level (codec-specific). Higher values = better compression but slower. |
609-
| `row_group_size` | No | `100000` | Number of rows per Parquet row group. |
610-
| `data_page_size` | No | `1048576` | Size of data pages in bytes (default 1MB). |
611-
| `statistics_enabled` | No | `true` | Enable Parquet column statistics: `true` or `false`. |
612-
| `parquet_version` | No | `2` | Parquet format version: `1` (v1.0) or `2` (v2.0). |
613-
| `raw_array_encoding` | No | `true` | Use raw encoding for arrays: `true` or `false`. |
604+
| Parameter | Required | Default | Description |
605+
|:---------------------|:---------|:----------------|:----------------------------------------------------------------------------------------------------|
606+
| `partition_by` | No | `NONE` | Partition unit: `NONE`, `HOUR`, `DAY`, `WEEK`, `MONTH`, or `YEAR`. |
607+
| `compression_codec` | No | `LZ4_RAW` | Compression algorithm: `UNCOMPRESSED`, `SNAPPY`, `GZIP`, `LZ4`, `ZSTD`, `LZ4_RAW`, `BROTLI`, `LZO`. |
608+
| `compression_level` | No | Codec-dependent | Compression level (codec-specific). Higher values = better compression but slower. |
609+
| `row_group_size` | No | `100000` | Number of rows per Parquet row group. |
610+
| `data_page_size` | No | `1048576` | Size of data pages in bytes (default 1MB). |
611+
| `statistics_enabled` | No | `true` | Enable Parquet column statistics: `true` or `false`. |
612+
| `parquet_version` | No | `2` | Parquet format version: `1` (v1.0) or `2` (v2.0). |
613+
| `raw_array_encoding` | No | `true` | Use raw encoding for arrays: `true` or `false`. |
614614

615615
The parameters must be URL encoded.
616616

@@ -673,7 +673,6 @@ curl -G \
673673
--data-urlencode "query=SELECT symbol, price, amount FROM trades WHERE timestamp > dateadd('h', -1, now())" \
674674
--data-urlencode "fmt=parquet" \
675675
--data-urlencode "compression_codec=LZ4_RAW" \
676-
--data-urlencode "compression_level=3" \
677676
http://localhost:9000/exp > recent_trades.parquet
678677
```
679678

0 commit comments

Comments
 (0)