Skip to content

Commit a39224d

Browse files
committed
more doc cleanup (after looking at it in github's markdown
1 parent 5d2ca2c commit a39224d

File tree

4 files changed

+26
-28
lines changed

4 files changed

+26
-28
lines changed

doc/implementing-tutorial.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ The goal of this tutorial is to be able to execute this:
1616
CREATE FOREIGN TABLE constanttable (
1717
test character varying,
1818
test2 character varying
19-
) server multicorn_srv options (
20-
wrapper 'myfdw.ConstantForeignDataWrapper'
19+
) server multicorn_srv OPTIONS (
20+
WRAPPER 'myfdw.ConstantForeignDataWrapper'
2121
)
2222

23-
SELECT * from constanttable;
23+
SELECT * FROM constanttable;
2424
```
2525
And obtain this as a result:
2626

doc/installation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@
88
- python >= 3.9 as your default python
99

1010
### With the `pgxn client`:
11-
```
11+
```bash
1212
pgxn install multicorn
1313
```
1414
### From pgxn:
15-
```
15+
```bash
1616
wget multicorn_pgxn_download
1717
unzip multicorn-multicorn_release
1818
cd multicorn-multicorn_release
1919
make && sudo make install
2020
```
2121
### From source:
22-
```
22+
```bash
2323
git clone git://github.com/pgsql-io/multicorn2.git
2424
cd multicorn2
2525
make && make install

doc/multicorn.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ to use:
2525

2626

2727
CREATE SERVER my_server_name FOREIGN DATA WRAPPER multicorn
28-
options (
29-
wrapper 'python.class.Name'
28+
OPTIONS (
29+
WRAPPER 'python.class.Name'
3030
)
3131

3232

@@ -38,8 +38,8 @@ Ex, for the Imap foreign data wrapper:
3838

3939

4040
CREATE SERVER multicorn_imap FOREIGN DATA WRAPPER multicorn
41-
options (
42-
wrapper 'multicorn.imapfdw.ImapFdw'
41+
OPTIONS (
42+
WRAPPER 'multicorn.imapfdw.ImapFdw'
4343
);
4444

4545

@@ -49,15 +49,13 @@ The foreign table must be supplied its required options.
4949

5050
Ex:
5151

52-
53-
54-
create foreign table gmail (
52+
CREATE FOREIGN TABLE gmail (
5553
"Message-ID" character varying,
5654
"From" character varying,
5755
"Subject" character varying,
5856
"payload" character varying,
5957
"flags" character varying[],
60-
"To" character varying) server multicorn_imap options (
58+
"To" character varying) SERVER multicorn_imap OPTIONS (
6159
host 'imap.gmail.com',
6260
port '465',
6361
payload_column 'payload',

doc/third-party-fdw.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ In addition to the built-in fdws shipped with Multicorn, there are some
44
third-party modules available on the net.
55

66

7-
## rethinkdb-multicorn-postgresql-fdw
7+
## rethinkdb-multicorn-postgresql fdw
88

99
A FDW for accessing RethinkDB databases
1010

11-
:read:
12-
:write:
11+
:read:
12+
:write:
1313

1414
repository:
1515
https://github.com/wilsonrmsorg/rethinkdb-multicorn-postgresql-fdw/
1616

1717

18-
## Hive FDW
18+
## hive fdw
1919

2020
Access data stored in Apache Hive tables.
2121

@@ -25,27 +25,27 @@ repository:
2525
https://github.com/youngwookim/hive-fdw-for-postgresql
2626

2727

28-
## dockerfdw
28+
## docker fdw
2929

3030

3131
A FDW for interacting with docker containers
3232

33-
:read:
34-
:write:
33+
:read:
34+
:write:
3535

3636
repository
3737
https://github.com/paultag/dockerfdw
3838

39-
## fb-psql
39+
## fb-psql fdw
4040

4141
Access data using Facebook FQL API
4242

43-
:read:
43+
:read:
4444

4545
repository
4646
https://github.com/mrwilson/fb-psql
4747

48-
## telemetry-fdw
48+
## telemetry fdw
4949

5050
Reads data from OpenStack / Telemetry.
5151

@@ -55,7 +55,7 @@ repository
5555
https://github.com/hhamalai/telemetry-fdw
5656

5757

58-
## s3csv_fdw
58+
## s3csv fdw
5959

6060
Reads data from CSV files stored on Amazon S3.
6161

@@ -65,7 +65,7 @@ repository
6565
https://github.com/eligoenergy/s3csv_fdw.git
6666

6767

68-
## S3Fdw
68+
## s3 fdw
6969

7070
Reads data from JSON files stored on Amazon S3
7171

@@ -75,15 +75,15 @@ repository
7575
https://github.com/blakedw/s3fdw.git
7676

7777

78-
## Database.com FDW
78+
## database.com-fdw
7979

8080
:read:
8181

8282
repository
8383
https://github.com/metadaddy-sfdc/Database.com-FDW-for-PostgreSQL.git
8484

8585

86-
# pgCassandra FDW
86+
# cassandra fdw
8787

8888
:read:
8989

0 commit comments

Comments
 (0)