Skip to content

Commit a6aea4e

Browse files
committed
Postgres scanner: Document pg_use_ctid_scan
Fixes #3208
1 parent e008928 commit a6aea4e

File tree

1 file changed

+33
-32
lines changed

1 file changed

+33
-32
lines changed

docs/extensions/postgres.md

+33-32
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,15 @@ dbname=postgresscanner
4747
host=localhost port=5432 dbname=mydb connect_timeout=10
4848
```
4949

50-
| Name | Description | Default |
51-
|------------|--------------------------------------|------------------|
52-
| `dbname` | Database name | [user] |
53-
| `host` | Name of host to connect to | `localhost` |
54-
| `hostaddr` | Host IP address | `localhost` |
55-
| `passfile` | Name of file passwords are stored in | `~/.pgpass` |
56-
| `password` | Postgres password | (empty) |
57-
| `port` | Port number | `5432` |
58-
| `user` | Postgres user name | current user |
50+
| Name | Description | Default |
51+
| ---------- | ------------------------------------ | ------------ |
52+
| `dbname` | Database name | [user] |
53+
| `host` | Name of host to connect to | `localhost` |
54+
| `hostaddr` | Host IP address | `localhost` |
55+
| `passfile` | Name of file passwords are stored in | `~/.pgpass` |
56+
| `password` | Postgres password | (empty) |
57+
| `port` | Port number | `5432` |
58+
| `user` | Postgres user name | current user |
5959

6060
An example URI is `postgresql://username@hostname/dbname`.
6161

@@ -89,7 +89,7 @@ SHOW ALL TABLES;
8989
<div class="narrow_table monospace_table"></div>
9090

9191
| name |
92-
|-------|
92+
| ----- |
9393
| uuids |
9494

9595
```sql
@@ -98,8 +98,8 @@ SELECT * FROM uuids;
9898

9999
<div class="narrow_table monospace_table"></div>
100100

101-
| u |
102-
|--------------------------------------|
101+
| u |
102+
| ------------------------------------ |
103103
| 6d3d2541-710b-4bde-b3af-4711738636bf |
104104
| NULL |
105105
| 00000000-0000-0000-0000-000000000001 |
@@ -154,9 +154,9 @@ INSERT INTO postgres_db.tbl VALUES (42, 'DuckDB');
154154
SELECT * FROM postgres_db.tbl;
155155
```
156156

157-
| id | name |
158-
|---:|--------|
159-
| 42 | DuckDB |
157+
| id | name |
158+
| ---: | ------ |
159+
| 42 | DuckDB |
160160

161161
### `COPY`
162162

@@ -237,9 +237,9 @@ INSERT INTO postgres_db.s1.integers VALUES (42);
237237
SELECT * FROM postgres_db.s1.integers;
238238
```
239239

240-
| i |
241-
|---:|
242-
| 42 |
240+
| i |
241+
| ---: |
242+
| 42 |
243243

244244
```sql
245245
DROP SCHEMA postgres_db.s1;
@@ -262,9 +262,9 @@ SELECT * FROM postgres_db.tmp;
262262

263263
This returns:
264264

265-
| i |
266-
|---:|
267-
| 42 |
265+
| i |
266+
| ---: |
267+
| 42 |
268268

269269
```sql
270270
ROLLBACK;
@@ -299,8 +299,8 @@ SELECT * FROM postgres_query('postgres_db', 'SELECT * FROM cars LIMIT 3');
299299
;
300300
-->
301301

302-
| brand | model | color |
303-
|--------------|------------|-------|
302+
| brand | model | color |
303+
| ------------ | ---------- | ----- |
304304
| Ferrari | Testarossa | red |
305305
| Aston Martin | DB2 | blue |
306306
| Bentley | Mulsanne | gray |
@@ -321,15 +321,16 @@ CALL postgres_execute('postgres_db', 'CREATE TABLE my_table (i INTEGER)');
321321

322322
The extension exposes the following configuration parameters.
323323

324-
| Name | Description | Default |
325-
|-----------------------------------|----------------------------------------------------------------------------|-----------|
326-
| `pg_debug_show_queries` | DEBUG SETTING: print all queries sent to Postgres to stdout | `false` |
327-
| `pg_connection_cache` | Whether or not to use the connection cache | `true` |
328-
| `pg_experimental_filter_pushdown` | Whether or not to use filter pushdown (currently experimental) | `false` |
329-
| `pg_array_as_varchar` | Read Postgres arrays as varchar - enables reading mixed dimensional arrays | `false` |
330-
| `pg_connection_limit` | The maximum amount of concurrent Postgres connections | `64` |
331-
| `pg_pages_per_task` | The amount of pages per task | `1000` |
332-
| `pg_use_binary_copy` | Whether or not to use BINARY copy to read data | `true` |
324+
| Name | Description | Default |
325+
| --------------------------------- | -------------------------------------------------------------------------- | ------- |
326+
| `pg_array_as_varchar` | Read Postgres arrays as varchar - enables reading mixed dimensional arrays | `false` |
327+
| `pg_connection_cache` | Whether or not to use the connection cache | `true` |
328+
| `pg_connection_limit` | The maximum amount of concurrent Postgres connections | `64` |
329+
| `pg_debug_show_queries` | DEBUG SETTING: print all queries sent to Postgres to stdout | `false` |
330+
| `pg_experimental_filter_pushdown` | Whether or not to use filter pushdown (currently experimental) | `false` |
331+
| `pg_pages_per_task` | The amount of pages per task | `1000` |
332+
| `pg_use_binary_copy` | Whether or not to use BINARY copy to read data | `true` |
333+
| `pg_use_ctid_scan` | Whether or not to parallelize scanning using table ctids | `true` |
333334

334335
## Schema Cache
335336

0 commit comments

Comments
 (0)