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.

Sign up for GitHub

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

update readme #2397

Changes from 6 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
139641a
update readme
universalmind303 Jan 10, 2024
6b34e5d
whoops
universalmind303 Jan 10, 2024
d34f9e4
Merge branch 'main' into universalmind303/readme-datasources
universalmind303 Jan 10, 2024
0da9da2
move lower in readme
universalmind303 Jan 10, 2024
05f9f30
Merge branch 'universalmind303/readme-datasources' of github.com:Glar…
universalmind303 Jan 10, 2024
699aadb
add adbc/odbc
universalmind303 Jan 10, 2024
89b1f01
Update README.md
universalmind303 Jan 11, 2024
70212e5
Merge branch 'main' into universalmind303/readme-datasources
universalmind303 Jan 11, 2024
ea85b8c
update readme
universalmind303 Jan 11, 2024
8c91c75
Merge branch 'main' into universalmind303/readme-datasources
universalmind303 Jan 11, 2024
727fc43
update table with footnotes & more info
universalmind303 Jan 11, 2024
1811094
Merge branch 'universalmind303/readme-datasources' of github.com:Glar…
universalmind303 Jan 11, 2024
05f1681
Merge branch 'main' of github.com:GlareDB/glaredb into universalmind3…
universalmind303 Jan 11, 2024
159a4d2
Merge branch 'main' into universalmind303/readme-datasources
universalmind303 Jan 11, 2024
96613a4
pr feedback
universalmind303 Jan 11, 2024
ed37a7a
update readme
universalmind303 Jan 12, 2024
58bb981
Merge branch 'main' into universalmind303/readme-datasources
universalmind303 Jan 12, 2024
44be3ac
update delta in readme
universalmind303 Jan 12, 2024
a1b3f83
Merge branch 'main' into universalmind303/readme-datasources
universalmind303 Jan 12, 2024
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
55 changes: 46 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ example, `~/.local/bin`.
If you prefer manual installation, download, extract and run the GlareDB binary
from a release in our [releases page].



## Getting started

After [Installing](#install), get up and running with:
Expand Down Expand Up @@ -94,17 +96,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 @@ -194,7 +196,42 @@ Done with this data source? Remove it with the following command:
```sql
DROP DATABASE my_pg;
```

## Supported data sources

| Source | Read | Write | Table Function | External Table | External Database | Supported Object Stores |
| ---------------------- | :--: | :---: | :------------: | :------------: | ----------------- | ----------------------------------- |
| **Databases** | -- | -- | -- | -- | -- | -- |
| MySQL | ✅ | ✅ | ✅ | ✅ | ✅ | ➖ |
| PostgreSQL | ✅ | ✅ | ✅ | ✅ | ✅ | ➖ |
| Microsoft SQL Server | ✅ | ✅ | ✅ | ✅ | ✅ | ➖ |
| MongoDB | ✅ | ✅ | ✅ | ✅ | ✅ | ➖ |
| Snowflake | ✅ | ✅ | ✅ | ✅ | ✅ | ➖ |
| BigQuery | ✅ | ✅ | ✅ | ✅ | ✅ | ➖ |
| Cassandra/ScyllaDB | ✅ | ✅ | ✅ | ✅ | ✅ | ➖ |
universalmind303 marked this conversation as resolved.
Show resolved Hide resolved
| Clickhouse | ✅ | ✅ | ✅ | ✅ | ✅ | ➖ |
universalmind303 marked this conversation as resolved.
Show resolved Hide resolved
| MariaDB (_via mysql)_ | ✅ | ✅ | ✅ | ✅ | ✅ | ➖ |
| DuckDB | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 | ➖ |
| Oracle | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 | ➖ |
| SQLite | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 | ➖ |
| ADBC | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 | ➖ |
| ODBC | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 | ➖ |
| **File Formats** | -- | -- | -- | -- | -- | -- |
| CSV | ✅ | ✅ | ✅ | ✅ | ➖ | HTTP, S3, Google, Azure, Local File |
| Newline Delimited JSON | ✅ | ✅ | ✅ | ✅ | ➖ | HTTP, S3, Google, Azure, Local File |
| Apache Parquet | ✅ | ✅ | ✅ | ✅ | ➖ | HTTP, S3, Google, Azure, Local File |
| Apache Arrow | ✅ | ✅ | ✅ | ✅ | ➖ | HTTP, S3, Google, Azure, Local File |
| Delta | ✅ | ✅ | ✅ | ✅ | ➖ | HTTP, S3, Google, Azure, Local File |
| BSON | ✅ | 🚧 | ✅ | ✅ | ➖ | Local File |
universalmind303 marked this conversation as resolved.
Show resolved Hide resolved
| Iceberg | ✅ | 🚧 | ✅ | ✅ | ➖ | HTTP, S3, Google, Azure, Local File |
| Lance | ✅ | 🚧 | ✅ | 🚧 | ➖ | HTTP, S3, Google, Azure, Local File |
universalmind303 marked this conversation as resolved.
Show resolved Hide resolved
| Microsoft Excel | ✅ | 🚧 | ✅ | 🚧 | ➖ | Local File |
| 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