Skip to content

Commit c0a0834

Browse files
committed
chore: maintain README
1 parent 787e18b commit c0a0834

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,25 @@
88
[docs-badge]: https://img.shields.io/docsrs/datafusion-postgres
99
[docs-url]: https://docs.rs/datafusion-postgres/latest/datafusion_postgres
1010

11-
A PostgreSQL-compatible server for [Apache DataFusion](https://datafusion.apache.org), supporting authentication, role-based access control, and SSL/TLS encryption. Available as both a library and CLI tool.
11+
A PostgreSQL-compatible server frontend for [Apache
12+
DataFusion](https://datafusion.apache.org). Available as both a library and CLI
13+
tool.
1214

13-
Built on [pgwire](https://github.com/sunng87/pgwire) to provide PostgreSQL wire protocol compatibility for analytical workloads.
14-
It was originally an example of the [pgwire](https://github.com/sunng87/pgwire)
15-
project.
15+
Built on [pgwire](https://github.com/sunng87/pgwire) to provide PostgreSQL wire
16+
protocol compatibility for analytical workloads. It was originally an example of
17+
the [pgwire](https://github.com/sunng87/pgwire) project.
1618

1719
## Scope of the Project
1820

1921
- `datafusion-postgres`: Postgres frontend for datafusion, as a library.
2022
- Serving Datafusion `SessionContext` with pgwire library
21-
- Customizible authentication
22-
- Permission control
23-
- Built-in `pg_catalog` tables
24-
- Built-in postgres functions for common meta queries
25-
- `datafusion-postgres-cli`: A cli tool starts a postgres compatible server for
26-
datafusion supported file formats, just like python's `SimpleHTTPServer`.
23+
- Customizible/Optional authentication and Permission control
24+
- `datafusion-pg-catalog`: A Postgres compatible `pg_catalog` schema and
25+
functions for datafusion backend.
2726
- `arrow-pg`: A data type mapping, encoding/decoding library for arrow and
2827
postgres(pgwire) data types.
29-
30-
See `auth.rs` for complete implementation examples using `DfAuthSource`.
28+
- `datafusion-postgres-cli`: A cli tool starts a postgres compatible server for
29+
datafusion supported file formats, just like python's `SimpleHTTPServer`.
3130

3231
## Supported Database Clients
3332

@@ -36,8 +35,10 @@ See `auth.rs` for complete implementation examples using `DfAuthSource`.
3635
- [x] DBeaver
3736
- [x] pgcli
3837
- [x] VSCode SQLTools
38+
- [ ] Intellij Datagrip
3939
- BI
4040
- [x] Metabase
41+
- [ ] PowerBI
4142

4243
## Quick Start
4344

@@ -51,7 +52,7 @@ options.
5152
use std::sync::Arc;
5253
use datafusion::prelude::SessionContext;
5354
use datafusion_postgres::{serve, ServerOptions};
54-
use datafusion_postgres::pg_catalog::setup_pg_catalog;
55+
use datafusion_pg_catalog::setup_pg_catalog;
5556

5657
// Create datafusion SessionContext
5758
let session_context = Arc::new(SessionContext::new());

0 commit comments

Comments
 (0)