Usage


Quick Start

1. Enable Extension

CREATE EXTENSION etcd_fdw;

2. Create Foreign Data Wrapper

CREATE FOREIGN DATA WRAPPER etcd_fdw
  HANDLER etcd_fdw_handler
  VALIDATOR etcd_fdw_validator;

3. Create Server

-- Basic connection
CREATE SERVER etcd_plain
  FOREIGN DATA WRAPPER etcd_fdw
  OPTIONS (connstr '127.0.0.1:2379');

-- Production etcd with authentication and SSL
CREATE SERVER etcd FOREIGN DATA WRAPPER etcd_fdw OPTIONS (
    connstr '127.0.0.1:2379',
    username 'root',
    password 'Etcd.Root',
    ssl_ca '/pg/cert/ca.crt',
    ssl_cert '/pg/cert/server.crt',
    ssl_key '/pg/cert/server.key'
);

4. Create Foreign Table

-- Basic table mapping all keys
CREATE FOREIGN TABLE etcd_kv (key TEXT, value TEXT) SERVER etcd OPTIONS (rowid_column 'key');

-- Table with prefix filter (only keys starting with '/config/')
CREATE FOREIGN TABLE etcd_config (key TEXT, value TEXT)
  SERVER etcd OPTIONS (rowid_column 'key', prefix '/config/');

5. Query Data

-- Read all keys
SELECT * FROM etcd_kv;

-- Filter by key pattern (pushdown supported)
SELECT * FROM etcd_kv WHERE key LIKE '/app/%';

-- Range query
SELECT * FROM etcd_kv WHERE key >= '/a' AND key < '/b';

-- Insert new key
INSERT INTO etcd_kv (key, value) VALUES ('/mykey', 'myvalue');

-- Delete key
DELETE FROM etcd_kv WHERE key = '/mykey';

6. Real-time Sync with etcd

Changes made outside PostgreSQL are immediately visible:

# Insert via etcdctl
etcdctl put '/config/db_pool_size' '20'
-- Instantly visible in PostgreSQL
SELECT * FROM etcd_config;
     key               | value
-----------------------+-------
 /config/db_pool_size  | 20
(1 row)

Reference

Server Options

OptionRequiredDescription
connstrYesetcd endpoint (e.g., 127.0.0.1:2379)
usernameNoAuthentication username
passwordNoAuthentication password
ssl_caNoCA certificate file path
ssl_certNoClient certificate file path
ssl_keyNoClient private key file path
ssl_servernameNoDomain name for TLS verification
connect_timeoutNoConnection timeout (default: 10s)
request_timeoutNoRequest timeout (default: 30s)

Foreign Table Options

OptionDefaultDescription
rowid_columnRequiredColumn used as unique row identifier
prefixNoneRestrict to keys with this prefix
keys_onlyfalseFetch only keys, skip values
revision0Read at specific etcd revision
key\0Starting key for range scan
range_endNoneExclusive end key for range scan
consistencyll (linearizable) or s (serializable)

Query Pushdown

The following operations are pushed down to etcd for better performance:

  • WHERE: =, >=, >, <=, <, BETWEEN, LIKE 'prefix%'
  • ORDER BY: Remote sorting
  • LIMIT/OFFSET: Remote pagination

Limitations

  • UPDATE on key column is not supported. Workaround: INSERT new key, then DELETE old key.
  • Requires etcd v3 API.

最后修改 2026-03-08: add extension catalog (baacba6)