Skip to content

Commit f60fa1b

Browse files
committed
docs: Update documentation to include protobuf installation instructions and rowid. Also clarify naming conventions for table columns
1 parent 544ce6b commit f60fa1b

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,11 @@ A foreign data wrapper around etcd for postgres
44
## Setup
55
- Install pgrx on your machine `cargo install --locked cargo-pgrx --version 0.14.3`
66
- Setup pgrx `cargo pgrx init`
7+
- Install protoc and protobuf (needed by etcd-client)
8+
- Instructions can be found [here](https://protobuf.dev/installation/)
79
- Have some kind of etcd you want to test and run
810

11+
912
## Build
1013
- To build simply run `cargo pgrx run` with or without the `--release` flag
1114

@@ -26,7 +29,7 @@ CREATE SERVER my_etcd_server foreign data wrapper etcd_fdw options (connstr '127
2629
```
2730

2831
```sql
29-
CREATE foreign table test (key text, value text) server my_etcd_server;
32+
CREATE foreign table test (key text, value text) server my_etcd_server options(rowid 'key');
3033
```
3134

3235
```sql
@@ -41,3 +44,4 @@ Which would yield something like:
4144
foo | bar
4245
(2 rows)
4346
```
47+
the rowid option is required. As are the names key and value for the columns.

0 commit comments

Comments
 (0)