Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewmturner authored Aug 30, 2024
1 parent 0fd04c6 commit cc9364d
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,21 @@ Some of the current and planned features are:

- Tab management to provide clean and structured organization of DataFusion queries, results, and context
- SQL editor
- Text editor for writing SQL queries
- Scrollable query results
- Track memory usage during query (TODO)
- Write query results to file (TODO)
- Multiple SQL Editor tabs (TODO)
- Query history
- History of executed queries
- History and statistics of executed queries
- ExecutionContext information
- Information from ExecutionContext / Catalog / ObjectStore / State / Config
- Logs
- Logs from `dft` and `DataFusion`
- `ObjectStore` Support
- S3 with custom endpoint / provider
- Custom `ObjectStore` Support
- S3, Azure(TODO), GCP(TODO)
- `ObjectStore` explorer. I.e. able to list files in `ObjectStore`
- `TableProvider` data sources
- Delta Table => `CREATE EXTERNAL TABLE table_name STORED AS DELTATABLE LOCATION 's3://bucket/table'` (Only available with `deltalake` feature)
- `TableProviderFactory` data sources
- Deltalake
- Iceberg (TODO)
- Hudi (TODO)
- Preloading DDL from `~/.datafusion/.datafusionrc` for local database available on startup

## User Guide
Expand All @@ -34,7 +33,7 @@ Some of the current and planned features are:

Currently, the only supported packaging is on [crates.io](https://crates.io/search?q=datafusion-tui). If you already have Rust installed it can be installed by running `cargo install datafusion-tui`. If rust is not installed you can download following the directions [here](https://www.rust-lang.org/tools/install).

Once installed you can run `dft` to start the application with DataFusion as the exection engine or `dft --host $HOST --port $PORT` to start the application with Ballista as the execution engine.
Once installed you can run `dft` to start the application.

#### Features

Expand Down Expand Up @@ -77,6 +76,14 @@ The default `connection_url` is `http://localhost:50051` but this can be configu
connection_url = "http://myhost:myport"
```

#### Deltalake (`--features=deltalake`)

Register deltalake tables. For example:

```sql
CREATE EXTERNAL TABLE table_name STORED AS DELTATABLE LOCATION 's3://bucket/table'
```

### Config

The `dft` configuration is stored in `~/.config/dft/config.toml`
Expand Down

0 comments on commit cc9364d

Please sign in to comment.