Skip to content

Commit

Permalink
update docs for new options
Browse files Browse the repository at this point in the history
  • Loading branch information
houqp committed Jan 12, 2025
1 parent df03b30 commit 15aad44
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 2 deletions.
15 changes: 13 additions & 2 deletions src/config/blob-store.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ROAPI currently supports the following blob storages:

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

For example, to serve a local parquet file `test_data/blogs.parquet`, you can
just set the uri to the file path:
Expand Down Expand Up @@ -42,8 +42,19 @@ tables:
ROAPI can build tables from datasets served through HTTP protocols. However, one
thing to keep in mind is HTTP store doesn't support partitioned datasets because
there is no native directory support in HTTP protocol.
there is no native directory listing support in the HTTP protocol.
To set custom headers for HTTP requests, you can use the `headers` io option:

```yaml
tables:
- name: "TABLE_NAME"
uri: "http://BUCKET/TABLE/KEY.csv"
io_option:
headers:
'Content-Type': 'application/json'
Authorization: 'Bearer TOKEN'
```

## S3

Expand Down
14 changes: 14 additions & 0 deletions src/config/databases.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,17 @@ tables:
```
With this, you can now write a single SQL query to join tables between MySQL, SQLite and local CSV files!
By default, ROAPI will use the provided table name as the table name to extract
data from the database. If you want to expose a specific database table with a
different name, you can use the `option` field to specify the original table
name like below:

```yaml
tables:
- name: custom_table_name
uri: "sqlite://path/to/sqlitelite/file"
option:
table: original_table_name
format: sqlite
```

0 comments on commit 15aad44

Please sign in to comment.