You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- `duckdb` is the binary for the duckdb shell with the extension code automatically loaded.
114
-
- `unittest` is the test runner of duckdb. Again, the extension is already linked into the binary.
115
-
- `<extension_name>.duckdb_extension` is the loadable binary as it would be distributed.
98
+
#### Endpoints Overview
116
99
117
-
## Running the extension
118
-
To run the extension code, simply start the shell with `./build/release/duckdb`. This shell will have the extension pre-loaded.
100
+
| Endpoint | Methods | Description |
101
+
|----------|---------|-------------|
102
+
|`/`| GET, POST | Query API endpoint |
103
+
|`/ping`| GET | Health check endpoint |
119
104
120
-
## Running the tests
121
-
Different tests can be created forDuckDB extensions. The primary way of testing DuckDB extensions should be the SQL testsin`./test/sql`. These SQL tests can be run using:
122
-
```sh
123
-
make test
124
-
```
105
+
#### Detailed Endpoint Specifications
106
+
107
+
##### Query API
108
+
109
+
**Methods:**`GET`, `POST`
110
+
111
+
**Parameters:**
112
+
113
+
| Parameter | Description | Supported Values |
114
+
|-----------|-------------|-------------------|
115
+
|`default_format`| Specifies the output format |`JSONEachRow`, `JSONCompact`|
116
+
|`query`| The DuckDB SQL query to execute | Any valid DuckDB SQL query |
117
+
118
+
##### Notes
119
+
120
+
- Ensure that your queries are properly formatted and escaped when sending them as part of the request.
121
+
- The root endpoint (`/`) supports both GET and POST methods, but POST is recommended for complex queries or when the query length exceeds URL length limitations.
122
+
- Always specify the `default_format` parameter to ensure consistent output formatting.
123
+
124
+
<br>
125
+
126
+
##### :black_joker: Disclaimers
127
+
128
+
[^1]: DuckDB ® is a trademark of DuckDB Foundation. All rights reserved by their respective owners. [^1]
129
+
[^2]: ClickHouse ® is a trademark of ClickHouse Inc. No direct affiliation or endorsement. [^2]
130
+
[^3]: Released under the MIT license. See LICENSE for details. All rights reserved by their respective owners. [^3]
0 commit comments