Skip to content

Commit 9006d82

Browse files
committed
chore: update readme
1 parent 58ca297 commit 9006d82

1 file changed

Lines changed: 13 additions & 18 deletions

File tree

README.md

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -74,21 +74,11 @@ let server_options = ServerOptions::new()
7474
serve(session_context, &server_options).await
7575
```
7676

77-
### Security Features
78-
79-
The server automatically includes:
80-
81-
- User authentication (default postgres superuser)
82-
- Role-based access control with predefined roles:
83-
- readonly: SELECT permissions
84-
- readwrite: SELECT, INSERT, UPDATE, DELETE permissions
85-
- dbadmin: Full administrative permissions
86-
- SSL/TLS encryption when certificates are provided
87-
- Query-level permission checking
88-
8977
### The CLI `datafusion-postgres-cli`
9078

91-
Command-line tool to serve JSON/CSV/Arrow/Parquet/Avro files as PostgreSQL-compatible tables.
79+
Command-line tool to serve JSON/CSV/Arrow/Parquet/Avro files as
80+
PostgreSQL-compatible tables. This is like a `SimpleHTTPServer` for hosting data
81+
files, but with Postgres protocol and datafusion query engine.
9282

9383
```
9484
datafusion-postgres-cli 0.6.1
@@ -114,7 +104,7 @@ OPTIONS:
114104
--tls-key <tls-key> Path to TLS private key file for SSL/TLS encryption
115105
```
116106

117-
#### 🔒 Security Options
107+
#### Security Options
118108

119109
```bash
120110
# Run with SSL/TLS encryption
@@ -127,7 +117,7 @@ datafusion-postgres-cli \
127117
datafusion-postgres-cli --csv data:sample.csv
128118
```
129119

130-
## 📋 Example Usage
120+
## Example Usage
131121

132122
### Basic Example
133123

@@ -145,8 +135,6 @@ Listening on 127.0.0.1:5432 (unencrypted)
145135

146136
### Connect with psql
147137

148-
> **🔐 Authentication**: The default setup allows connections without authentication for development. For secure deployments, use `DfAuthSource` with standard pgwire authentication handlers (cleartext, MD5, or SCRAM). See `auth.rs` for implementation examples.
149-
150138
```bash
151139
psql -h 127.0.0.1 -p 5432 -U postgres
152140
```
@@ -179,7 +167,7 @@ postgres=> COMMIT;
179167
COMMIT
180168
```
181169

182-
### 🔐 Production Setup with SSL/TLS
170+
### SSL/TLS
183171

184172
```bash
185173
# Generate SSL certificates
@@ -199,6 +187,13 @@ TLS enabled using cert: server.crt and key: server.key
199187
Listening on 127.0.0.1:5432 with TLS encryption
200188
```
201189

190+
## PostGIS/Geodatafusion
191+
192+
With [geodatafusion](https://github.com/datafusion-contrib/geodatafusion), we
193+
can also simulate PostGIS interface (UDF and datatypes) with
194+
datafusion-postgres. To enable this feature, turn on the feature flag `postgis`
195+
for `datafusion-postgres`.
196+
202197
## Community
203198

204199
### Developer Mailing List

0 commit comments

Comments
 (0)