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

Jump to bottom

chore: update readme table and style #2800

Merged
merged 4 commits into from
Mar 20, 2024
Merged

chore: update readme table and style #2800

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
39ef7bd
chore: update readme table and style
tychoish Mar 20, 2024
2ddb638
order tweaks
tychoish Mar 20, 2024
aa9048c
Merge branch 'main' into tycho/readme-update
tychoish Mar 20, 2024
074262d
another division
tychoish Mar 20, 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
78 changes: 38 additions & 40 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ example, `~/.local/bin`.
If you prefer manual installation, download, extract and run the GlareDB binary
from a release in our [releases page].

## Getting started
## Getting Started

After [Installing](#install), get up and running with:

Expand Down Expand Up @@ -138,7 +138,7 @@ df = con.sql("select * from df where fruits = 'banana'").to_polars();
print(df)
```

### Local server
### Local Server

The `server` subcommand can be used to launch a server process for GlareDB:

Expand All @@ -160,9 +160,9 @@ running server:
psql "host=localhost user=glaredb dbname=glaredb port=6543"
```

## Your first data source
## Configure the First Data Source

A demo Postgres instance is deployed at `pg.demo.glaredb.com`. Adding this
You can use a demo Postgres instance at `pg.demo.glaredb.com`. Adding this
Postgres instance as data source is as easy as running the following command:

```sql
Expand Down Expand Up @@ -196,46 +196,44 @@ 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 | ✅ | ✅\* | ✅ | ✅ | ➖ |
| Lance | ✅ | ✅\* | ✅ | ✅ | ➖ |
| Delta | ✅ | 🚧 | ✅ | ✅ | ➖ |
| Iceberg | ✅ | 🚧 | ✅ | ✅ | ➖ |
| Microsoft Excel | ✅ | 🚧 | ✅ | 🚧 | ➖ |
| JSON | 🚧 | 🚧 | 🚧 | 🚧 | ➖ |
| Apache Avro | 🚧 | 🚧 | 🚧 | 🚧 | ➖ |
| Apache ORC | 🚧 | 🚧 | 🚧 | 🚧 | ➖ |
## Supported Data Sources

| Source | Read | `INSERT INTO` | `COPY TO` | Table Function | External Table | External Database |
|-----------------------|:----:|:-------------:|-----------|:--------------:|:--------------:|-------------------|
| **Databases** | -- | -- | -- | -- | -- | -- |
| MySQL | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| PostgreSQL | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| MariaDB _(via mysql)_ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Microsoft SQL Server | ✅ | 🚧 | 🚧 | ✅ | ✅ | ✅ |
| MongoDB | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| SQLite | ✅ | ✅ | 🚧 | ✅ | ✅ | ✅ |
| Snowflake | ✅ | 🚧 | 🚧 | ✅ | ✅ | ✅ |
| BigQuery | ✅ | 🚧 | 🚧 | ✅ | ✅ | ✅ |
| Cassandra/ScyllaDB | ✅ | 🚧 | 🚧 | ✅ | ✅ | ✅ |
| ClickHouse | ✅ | 🚧 | 🚧 | ✅ | ✅ | ✅ |
| Microsoft Excel | ✅ | 🚧 | 🚧 | ✅ | ✅ | ➖ |
| DuckDB | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 |
| Oracle | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 |
| ADBC | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 |
| ODBC | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 |
| **File Formats** | -- | -- | -- | -- | -- | -- |
| Apache Arrow | ✅ | 🚧 | ✅ | ✅ | ✅ | ➖ |
| Apache Parquet | ✅ | 🚧 | ✅ | ✅ | ✅ | ➖ |
| CSV | ✅ | 🚧 | ✅ | ✅ | ✅ | ➖ |
| JSON | ✅ | 🚧 | ✅ | ✅ | ✅ | ➖ |
| BSON | ✅ | 🚧 | ✅ | ✅ | ✅ | ➖ |
| Apache Avro | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 | ➖ |
| Apache ORC | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 | ➖ |
| **Table Formats** | -- | -- | -- | -- | -- | -- |
| Lance | ✅ | ✅ | ✅ | ✅ | ✅ | ➖ |
| Delta | ✅ | 🚧 | 🚧 | ✅ | ✅ | ➖ |
| Iceberg | ✅ | 🚧 | 🚧 | ✅ | ✅ | ➖ |

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

\* `COPY TO` support only

## Building from source
## Building from Source

Building GlareDB requires Rust/Cargo to be installed. Check out [rustup](https://rustup.rs/) for
an easy way to install Rust on your system.
Expand All @@ -248,7 +246,7 @@ just build --release

The compiled release binary can be found in `target/release/glaredb`.

## Docs
## Documentation

Browse GlareDB documentation on our [docs.glaredb.com](https://docs.glaredb.com).

Expand Down
Loading