Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme #2397

Merged
merged 19 commits into from
Jan 12, 2024
Merged
Changes from 14 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 48 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,43 @@ Done with this data source? Remove it with the following command:
DROP DATABASE my_pg;
```

## Supported data sources

| Source | Read | Write[^1] | Table Function | External Table | External Database | Supported Object Stores[^2] |
| ---------------------- | :--: | :-------: | :------------: | :------------: | ----------------- | --------------------------- |
| **Databases** | -- | | -- | -- | -- | |
| MySQL | ✅ | ✅✅ | ✅ | ✅ | ✅ | ➖ |
universalmind303 marked this conversation as resolved.
Show resolved Hide resolved
| PostgreSQL | ✅ | ✅✅ | ✅ | ✅ | ✅ | ➖ |
| MariaDB _(via mysql)_ | ✅ | ✅✅ | ✅ | ✅ | ✅ | ➖ |
| Microsoft SQL Server | ✅ | 🚧🚧 | ✅ | ✅ | ✅ | ➖ |
| MongoDB | ✅ | 🚧🚧 | ✅ | ✅ | ✅ | ➖ |
| Snowflake | ✅ | 🚧🚧 | ✅ | ✅ | ✅ | ➖ |
| BigQuery | ✅ | 🚧🚧 | ✅ | ✅ | ✅ | ➖ |
| Cassandra/ScyllaDB | ✅ | 🚧🚧 | ✅ | ✅ | ✅ | ➖ |
| ClickHouse | ✅ | 🚧🚧 | ✅ | ✅ | ✅ | ➖ |
| DuckDB | 🚧 | 🚧🚧 | 🚧 | 🚧 | 🚧 | ➖ |
| Oracle | 🚧 | 🚧🚧 | 🚧 | 🚧 | 🚧 | ➖ |
| SQLite | 🚧 | 🚧🚧 | 🚧 | 🚧 | 🚧 | ➖ |
| ADBC | 🚧 | 🚧🚧 | 🚧 | 🚧 | 🚧 | ➖ |
| ODBC | 🚧 | 🚧🚧 | 🚧 | 🚧 | 🚧 | ➖ |
| **File Formats** | -- | -- | -- | -- | -- | |
| Apache Arrow | ✅ | ✅✅ | ✅ | ✅ | ➖ | ✅✅✅✅✅ |
| Delta | ✅ | ✅✅ | ✅ | ✅ | ➖ | ✅✅✅✅✅ |
| CSV | ✅ | ✅🚧 | ✅ | ✅ | ➖ | ✅✅✅✅✅ |
| Newline Delimited JSON | ✅ | ✅🚧 | ✅ | ✅ | ➖ | ✅✅✅✅✅ |
| Apache Parquet | ✅ | ✅🚧 | ✅ | ✅ | ➖ | ✅✅✅✅✅ |
| BSON | ✅ | ✅🚧 | ✅ | ✅ | ➖ | ✅✅✅✅✅ |
| Iceberg | ✅ | 🚧 | ✅ | ✅ | ➖ | ✅✅✅✅✅ |
| Lance | ✅ | 🚧 | ✅ | ✅ | ➖ | ✅✅✅✅✅ |
| Microsoft Excel | ✅ | 🚧 | ✅ | 🚧 | ➖ | ✅🚧🚧🚧🚧 |
| JSON | 🚧 | 🚧 | 🚧 | 🚧 | ➖ | 🚧🚧🚧🚧🚧 |
| Apache Avro | 🚧 | 🚧 | 🚧 | 🚧 | ➖ | 🚧🚧🚧🚧🚧 |
| Apache ORC | 🚧 | 🚧 | 🚧 | 🚧 | ➖ | 🚧🚧🚧🚧🚧 |

✅ = Supported
➖ = Not Applicable
🚧 = Not Yet Supported

## Building from source

Building GlareDB requires Rust/Cargo to be installed. Check out [rustup](https://rustup.rs/) for
Expand Down Expand Up @@ -234,3 +271,6 @@ GlareDB is proudly powered by [Apache Datafusion](https://arrow.apache.org/dataf
[Pandas]: https://github.com/pandas-dev/pandas
[Polars]: https://github.com/pola-rs/polars
[supported data sources]: https://docs.glaredb.com/docs/data-sources/supported/

[^1]: Supported write modes are `COPY TO` and `INSERT INTO`.
[^2]: Supported object stores are: Local File, HTTP (GET), Amazon S3, Google Cloud Storage, Azure Blob Storage.