diff --git a/src/config/blob-store.md b/src/config/blob-store.md index 59d9186..79093ef 100644 --- a/src/config/blob-store.md +++ b/src/config/blob-store.md @@ -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: @@ -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 diff --git a/src/config/databases.md b/src/config/databases.md index dab3a3b..c0248a1 100644 --- a/src/config/databases.md +++ b/src/config/databases.md @@ -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 +```