Skip to content

Commit

Permalink
update readme (#2397)
Browse files Browse the repository at this point in the history
closes #2394
I think this is a pretty comprehensive list. 

I'd suggest reviewers to doublecheck just in case I accidentally marked
some of them as supported that are not (or vice-versa).

---------

Co-authored-by: Sean Smith <scsmithr@gmail.com>
  • Loading branch information
universalmind303 and scsmithr authored Jan 12, 2024
1 parent 8f31b04 commit 388a597
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 8 deletions.
55 changes: 47 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,17 +94,17 @@ Read our [announcement on Hybrid Execution] for more information.
1. Install the official [GlareDB Python library]
```shell
pip install glaredb
```
```shell
pip install glaredb
```
2. Import and use `glaredb`.
```python
import glaredb
con = glaredb.connect()
con.sql("select 'hello world';").show()
```
```python
import glaredb
con = glaredb.connect()
con.sql("select 'hello world';").show()
```
To use **Hybrid Execution**, sign up at <https://console.glaredb.com> and
use the connection string for your deployment. For example:
Expand Down Expand Up @@ -195,6 +195,45 @@ Done with this data source? Remove it with the following command:
DROP DATABASE my_pg;
```
## Supported data sources
| Source | Read | Write | Table Function | External Table | External Database |
| ---------------------- | :--: | :---: | :------------: | :------------: | ----------------- |
| **Databases** | -- | | -- | -- | -- |
| MySQL ||||||
| PostgreSQL ||||||
| MariaDB _(via mysql)_ ||||||
| Microsoft SQL Server || 🚧 ||||
| MongoDB || 🚧 ||||
| Snowflake || 🚧 ||||
| BigQuery || 🚧 ||||
| Cassandra/ScyllaDB || 🚧 ||||
| ClickHouse || 🚧 ||||
| DuckDB | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 |
| Oracle | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 |
| SQLite | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 |
| ADBC | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 |
| ODBC | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 |
| **File Formats** | -- | -- | -- | -- | -- |
| Apache Arrow ||\* ||||
| CSV ||\* ||||
| Newline Delimited JSON ||\* ||||
| Apache Parquet ||\* ||||
| BSON ||\* ||||
| Delta || 🚧 ||||
| Iceberg || 🚧 ||||
| Lance || 🚧 ||||
| Microsoft Excel || 🚧 || 🚧 ||
| JSON | 🚧 | 🚧 | 🚧 | 🚧 ||
| Apache Avro | 🚧 | 🚧 | 🚧 | 🚧 ||
| Apache ORC | 🚧 | 🚧 | 🚧 | 🚧 ||
✅ = Supported
➖ = Not Applicable
🚧 = Not Yet Supported
\* `COPY TO` support only
## Building from source
Building GlareDB requires Rust/Cargo to be installed. Check out [rustup](https://rustup.rs/) for
Expand Down
1 change: 1 addition & 0 deletions testdata/sqllogictests/functions/postgres.slt
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ public

skipif glaredb_flight
query T

select current_user;
----
glaredb
Expand Down

0 comments on commit 388a597

Please sign in to comment.