Skip to content

Commit 15aad44

Browse files
committed
update docs for new options
1 parent df03b30 commit 15aad44

File tree

2 files changed

+27
-2
lines changed

2 files changed

+27
-2
lines changed

src/config/blob-store.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ROAPI currently supports the following blob storages:
1212

1313
Filesystem store can be specified using `file:` or `filesystem:` schemes. In a
1414
Windows environment, the scheme is mandatory. On Unix systems, a uri without a
15-
scheme prefix is treated as filesystem backed data source by ROAPI.
15+
scheme prefix is treated as filesystem backed data source by ROAPI.
1616

1717
For example, to serve a local parquet file `test_data/blogs.parquet`, you can
1818
just set the uri to the file path:
@@ -42,8 +42,19 @@ tables:
4242
4343
ROAPI can build tables from datasets served through HTTP protocols. However, one
4444
thing to keep in mind is HTTP store doesn't support partitioned datasets because
45-
there is no native directory support in HTTP protocol.
45+
there is no native directory listing support in the HTTP protocol.
4646
47+
To set custom headers for HTTP requests, you can use the `headers` io option:
48+
49+
```yaml
50+
tables:
51+
- name: "TABLE_NAME"
52+
uri: "http://BUCKET/TABLE/KEY.csv"
53+
io_option:
54+
headers:
55+
'Content-Type': 'application/json'
56+
Authorization: 'Bearer TOKEN'
57+
```
4758

4859
## S3
4960

src/config/databases.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,17 @@ tables:
1515
```
1616
1717
With this, you can now write a single SQL query to join tables between MySQL, SQLite and local CSV files!
18+
19+
By default, ROAPI will use the provided table name as the table name to extract
20+
data from the database. If you want to expose a specific database table with a
21+
different name, you can use the `option` field to specify the original table
22+
name like below:
23+
24+
```yaml
25+
tables:
26+
- name: custom_table_name
27+
uri: "sqlite://path/to/sqlitelite/file"
28+
option:
29+
table: original_table_name
30+
format: sqlite
31+
```

0 commit comments

Comments
 (0)