Building and Distributing PostgreSQL Extensions Without Learning C

1. Building and Distributing PostgreSQL Extensions Without Learning C David E. Wheeler PostgreSQL Experts, Inc. PGXPUG PgDay 2011 Text: Attribution-Noncommercial-Share Alike 3.0 United States: http://creativecommons.org/licenses/by-nc-sa/3.0/us/ Images licensed independently and © Their respective owners.

3. There are quite a few PostgreSQL Extensions.

4. Core Extensions

5. Core Extensions intagg pgcrypto intarray btree_gin hstore chkpass citext dblink cube earthdistance isn fuzzystrmatch

6. Common Extensions

7. Common Extensions PostGIS PL/R temporal OracleFCE pgmemcache mysqlcompat PL/Proxy pg_randomness PL/Java pgTAP PL/Ruby

9. You can create extensions, too!

11. I know what you’re thinking…

13. “Sure, but I get C sick.”

15. Fortunately…

17. There are many ways to extend PostgreSQL.

18. Functions truth.sql

19. Functions CREATE FUNCTION truthy(     text ) RETURNS BOOLEAN IMMUTABLE LANGUAGE SQL AS  $$     SELECT $1 IS NOT NULL        AND $1 NOT IN ('', '0')        AND NOT $1 ~ '^[0.]+$'; $$; truth.sql

24. Functions CREATE FUNCTION truthy(     text ) RETURNS BOOLEAN IMMUTABLE LANGUAGE SQL AS  $$     SELECT $1 IS NOT NULL        AND $1 NOT IN ('', '0')        AND NOT $1 ~ '^[0.]+$'; $$; truth.sql Might be handy!

25. Domains timezone.sql

26. Domains CREATE OR REPLACE FUNCTION is_timezone(     tz CITEXT ) RETURNS BOOLEAN LANGUAGE plpgsql STABLE AS $$ BEGIN     PERFORM NOW() AT TIME ZONE tz;     RETURN TRUE; EXCEPTION WHEN invalid_parameter_value THEN     RETURN FALSE; END; $$; CREATE DOMAIN timezone AS CITEXT  CHECK ( is_timezone( VALUE ) ); timezone.sql

33. Domains CREATE OR REPLACE FUNCTION is_timezone(     tz CITEXT ) RETURNS BOOLEAN LANGUAGE plpgsql STABLE AS $$ BEGIN     PERFORM NOW() AT TIME ZONE tz;     RETURN TRUE; EXCEPTION WHEN invalid_parameter_value THEN     RETURN FALSE; END; $$; I use this CREATE DOMAIN timezone AS CITEXT  CHECK ( is_timezone( VALUE ) ); timezone.sql

34. Types pair.sql

35. Types CREATE TYPE pair AS ( k text, v text ); CREATE OR REPLACE FUNCTION store(     params variadic pair[] ) RETURNS VOID LANGUAGE plpgsql AS $$ DECLARE     param pair; BEGIN     FOR param IN SELECT * FROM unnest(params) LOOP         ‐‐ ...     END LOOP; END; $$ pair.sql

39. Types CREATE TYPE pair AS ( k text, v text ); CREATE OR REPLACE FUNCTION store(     params variadic pair[] ) RETURNS VOID LANGUAGE plpgsql AS $$ DECLARE     param pair; BEGIN     FOR param IN SELECT * FROM unnest(params) LOOP         ‐‐ ...     END LOOP; END; $$ pair.sql Could be useful…

40. Operators truthy.sql

41. Operators CREATE OPERATOR @ (   RIGHTARG  = text,   PROCEDURE = truthy ); truthy.sql

44. Operators CREATE OPERATOR @ (   RIGHTARG  = text,   PROCEDURE = truthy ); SELECT @'foo'; ‐‐ true SELECT @'';    ‐‐ false truthy.sql

45. Operators CREATE OPERATOR @ (   RIGHTARG  = text,   PROCEDURE = truthy ); SELECT @'foo'; ‐‐ true SELECT @'';    ‐‐ false truthy.sql I could use this!

47. PostgreSQL is not merely a database…

49. …It’s an application development platform.

51. Develop reusable extension libraries…

53. And combine them when building apps.

56. Let’s create an extension and distribute it.

57. The Steps

58. The Steps Stub source, test, and doc ﬁles

59. The Steps Stub source, test, and doc ﬁles Create the Makeﬁle

60. The Steps Stub source, test, and doc ﬁles Create the Makeﬁle Write the tests

61. The Steps Stub source, test, and doc ﬁles Create the Makeﬁle Write the tests Write the code

62. The Steps Stub source, test, and doc ﬁles Create the Makeﬁle Write the tests Write the code Write the docs

63. The Steps Stub source, test, and doc files Create the Makefile Write the tests Write the code Write the docs Create the metadata file

64. The Steps Stub source, test, and doc files Create the Makefile Write the tests Write the code Write the docs Create the metadata file Package it up

65. The Steps Stub source, test, and doc files Create the Makefile Write the tests Write the code Write the docs Create the metadata file Package it up Release

66. Stub the Source sql/pair.sql

67. Stub the Source SET client_min_messages = warning; ‐‐ Create the type here. sql/pair.sql

70. Stub the Source SET client_min_messages = warning; ‐‐ Create the type here. sql/pair.sql sql/pair.sql

71. Stub the Tests test/sql/base.sql

72. Stub the Tests BEGIN; set ECHO 0 set QUIET 1 i sql/pair.sql set QUIET 0 ROLLBACK; test/sql/base.sql

73. Stub the Tests BEGIN; set ECHO 0 set QUIET 1 i sql/pair.sql set QUIET 0 ROLLBACK; test/sql/base.sql

74. Stub the Tests BEGIN; set ECHO 0 set QUIET 1 i sql/pair.sql set QUIET 0 ROLLBACK; test/sql/base.sql test/sql/base.sql

75. Stub the Docs test/sql/base.sql

76. Stub the Docs pair 0.1.0 ========== Synopsis ‐‐‐‐‐‐‐‐     ‐‐ Example code here.      Description ‐‐‐‐‐‐‐‐‐‐‐ This library blah blah blah... Usage ‐‐‐‐‐ Here's how to use this library. Author ‐‐‐‐‐‐ [David E. Wheeler](http://justatheory.com/) Copyright ‐‐‐‐‐‐‐‐‐ Copyright (c) 2010 David E. Wheeler. test/sql/base.sql

77. Stub the Docs pair 0.1.0 doc/pair.txt ========== Synopsis ‐‐‐‐‐‐‐‐     ‐‐ Example code here.      Description ‐‐‐‐‐‐‐‐‐‐‐ This library blah blah blah... Usage ‐‐‐‐‐ Here's how to use this library. Author ‐‐‐‐‐‐ [David E. Wheeler](http://justatheory.com/) Copyright ‐‐‐‐‐‐‐‐‐ Copyright (c) 2010 David E. Wheeler. test/sql/base.sql

78. Create the Makeﬁle Makefile

79. Create the Makeﬁle DATA    = $(wildcard sql/*.sql) DOCS    = $(wildcard doc/*.*) MODULES = $(patsubst %.c,%,$(wildcard src/*.c)) Makefile

83. Create the Makeﬁle DATA    = $(wildcard sql/*.sql) DOCS    = $(wildcard doc/*.*) MODULES = $(patsubst %.c,%,$(wildcard src/*.c)) TESTS = $(wildcard test/sql/*.sql) REGRESS = $(patsubst test/sql/%.sql,%,$(TESTS)) REGRESS_OPTS = ‐‐inputdir=test Makefile

87. Create the Makeﬁle inputdir DATA    = $(wildcard sql/*.sql) DOCS    = $(wildcard doc/*.*) MODULES = $(patsubst %.c,%,$(wildcard src/*.c)) TESTS = $(wildcard test/sql/*.sql) REGRESS = $(patsubst test/sql/%.sql,%,$(TESTS)) REGRESS_OPTS = ‐‐inputdir=test Makefile

88. Create the Makeﬁle DATA    = $(wildcard sql/*.sql) DOCS    = $(wildcard doc/*.*) MODULES = $(patsubst %.c,%,$(wildcard src/*.c)) TESTS = $(wildcard test/sql/*.sql) REGRESS = $(patsubst test/sql/%.sql,%,$(TESTS)) REGRESS_OPTS = ‐‐inputdir=test PG_CONFIG = pg_config PGXS := $(shell $(PG_CONFIG) ‐‐pgxs) include $(PGXS) Makefile

92. Give it a Try % 

93. Give it a Try   make %  make: Nothing to be done for `all'. %

94. Give it a Try   make %  make: Nothing to be done for `all'.   make installcheck % pg_regress ‐‐psqldir=/pgsql/bin ‐‐inputdir=test base === dropping database "regression"  === DROP DATABASE === creating database "regression"  === CREATE DATABASE ALTER DATABASE === running regression test queries === test base                 ... diff:   test/expected/base.out: No such file or directory diff command failed with status 512:   diff  "test/expected/base.out" "results/base.out" >  "results/base.out.diff" make: *** [installcheck] Error 2 %

95. Give it a Try   make %  make: Nothing to be done for `all'.   make installcheck % pg_regress ‐‐psqldir=/pgsql/bin ‐‐inputdir=test base === dropping database "regression"  === DROP DATABASE === creating database "regression"  === CREATE DATABASE ALTER DATABASE === running regression test queries === test base                 ... diff:   test/expected/base.out: No such file or directory diff command failed with status 512:   diff  "test/expected/base.out" "results/base.out" >  "results/base.out.diff" make: *** [installcheck] Error 2 %

96. Give it a Try   make %  make: Nothing to be done for `all'.   make installcheck % pg_regress ‐‐psqldir=/pgsql/bin ‐‐inputdir=test base === dropping database "regression"  === DROP DATABASE === creating database "regression"  === We’ll come CREATE DATABASE ALTER DATABASE back to that. === running regression test queries === test base                 ... diff:   test/expected/base.out: No such file or directory diff command failed with status 512:   diff  "test/expected/base.out" "results/base.out" >  "results/base.out.diff" make: *** [installcheck] Error 2 %

97. Write Some Tests i sql/pair.sql set QUIET 0 ROLLBACK; test/sql/base.sql

98. Write Some Tests i sql/pair.sql set QUIET 0       SELECT pair('foo', 'bar') UNION SELECT pair('HEY'::text, 'bar') UNION SELECT pair('foo'::text, 'woah'::text) UNION SELECT pair('ick', 'foo'::text) UNION SELECT pair('foo'::text, 1) UNION SELECT pair(12.3, 'foo'::text) UNION SELECT pair(1, 12) ORDER BY pair; ROLLBACK; test/sql/base.sql

102. Run Them % 

103. Run Them %    psql ‐d try ‐Xf test/sql/base.sql BEGIN psql:test/sql/base.sql:15: ERROR:  function pair(unknown,  unknown) does not exist LINE 1: SELECT pair('foo', 'bar')                ^ ROLLBACK %

104. Run Them %    psql ‐d try ‐Xf test/sql/base.sql BEGIN psql:test/sql/base.sql:15: ERROR:  function pair(unknown,  unknown) does not exist LINE 1: SELECT pair('foo', 'bar')                ^ ROLLBACK % Guess we should write it.

105. SET client_min_messages = warning; ‐‐ Create the type here. sql/pair.sql

106. SET client_min_messages = warning; CREATE TYPE pair AS ( k text, v text ); CREATE OR REPLACE FUNCTION pair(anyelement, text) RETURNS pair LANGUAGE SQL AS 'SELECT ROW($1, $2)::pair'; CREATE OR REPLACE FUNCTION pair(text, anyelement) RETURNS pair LANGUAGE SQL AS 'SELECT ROW($1, $2)::pair'; CREATE OR REPLACE FUNCTION pair(anyelement, anyelement) RETURNS pair LANGUAGE SQL AS 'SELECT ROW($1, $2)::pair'; CREATE OR REPLACE FUNCTION pair(text, text) RETURNS pair LANGUAGE SQL AS 'SELECT ROW($1, $2)::pair;'; sql/pair.sql

112. %

113. %   psql ‐d try ‐Xf test/sql/base.sql BEGIN     pair     ‐‐‐‐‐‐‐‐‐‐‐‐  (1,12)  (12.3,foo)  (HEY,bar)  (foo,1)  (foo,bar)  (foo,woah)  (ick,foo) (7 rows) ROLLBACK % W00t!

114. Moar Tests! UNION SELECT pair(12.3, 'foo'::text) UNION SELECT pair(1, 12) ORDER BY pair; ROLLBACK; test/sql/base.sql

115. Moar Tests! UNION SELECT pair(12.3, 'foo'::text) UNION SELECT pair(1, 12) ORDER BY pair;       SELECT 'foo' ~> 'bar' AS arrowop UNION SELECT 'HEY'::text ~> 'bar' UNION SELECT 'foo'::text ~> 'woah'::text UNION SELECT 'ick' ~> 'foo'::text UNION SELECT 'foo'::text ~> 1 UNION SELECT 12.3 ~> 'foo'::text UNION SELECT 1 ~> 12 ORDER BY arrowop; ROLLBACK; test/sql/base.sql

119. %

120. %   psql ‐d try ‐Xf test/sql/base.sql BEGIN     pair     ‐‐‐‐‐‐‐‐‐‐‐‐  (1,12)  (12.3,foo)  (HEY,bar)  (foo,1)  (foo,bar)  (foo,woah)  (ick,foo) (7 rows) psql:test/sql/base.sql:25: ERROR:  operator does not exist:  unknown ~> unknown LINE 1: SELECT 'foo' ~> 'bar' AS arrowop                      ^ HINT:  No operator matches the given name and argument  type(s). You might need to add explicit type casts. ROLLBACK %

121.  (foo,1)  (foo,bar) %  (foo,woah)  (ick,foo) (7 rows) psql:test/sql/base.sql:25: ERROR:  operator  unknown ~> unknown LINE 1: SELECT 'foo' ~> 'bar' AS arrowop                      ^ Guess we HINT:  No operator matches the given name an should write it. type(s). You might need to add explicit type ROLLBACK %

122. CREATE OR REPLACE FUNCTION pair(text, text) RETURNS pair LANGUAGE SQL AS 'SELECT ROW($1, $2)::pair;'; sql/pair.sql

123. CREATE OR REPLACE FUNCTION pair(text, text) RETURNS pair LANGUAGE SQL AS 'SELECT ROW($1, $2)::pair;'; CREATE OPERATOR ~> (   LEFTARG   = text,   RIGHTARG  = anyelement,   PROCEDURE = pair ); CREATE OPERATOR ~> (   LEFTARG   = anyelement,   RIGHTARG  = text,   PROCEDURE = pair ); CREATE OPERATOR ~> (   LEFTARG   = anyelement,   RIGHTARG  = anyelement,   PROCEDURE = pair ); CREATE OPERATOR ~> (   LEFTARG   = text,   RIGHTARG  = text,   PROCEDURE = pair ); sql/pair.sql

128. %

129. %   psql ‐d try ‐Xf test/sql/base.sql BEGIN     pair     ‐‐‐‐‐‐‐‐‐‐‐‐  (1,12)  (12.3,foo)  (HEY,bar)  (foo,1)  (foo,bar)  (foo,woah)  (ick,foo) (7 rows)   arrowop    ‐‐‐‐‐‐‐‐‐‐‐‐  (1,12)  (12.3,foo)  (HEY,bar)  (foo,1)  (foo,bar)  (foo,woah)  (ick,foo) (7 rows) ROLLBACK

130.  (foo,bar)  (foo,woah) %  (ick,foo) (7 rows)   arrowop    ‐‐‐‐‐‐‐‐‐‐‐‐  (1,12)  (12.3,foo)  (HEY,bar)  (foo,1)  (foo,bar)  (foo,woah)  (ick,foo) (7 rows) Yay! ROLLBACK

131. One More Time! UNION SELECT 12.3 ~> 'foo'::text UNION SELECT 1 ~> 12 ORDER BY arrowop; ROLLBACK; test/sql/base.sql

132. One More Time! UNION SELECT 12.3 ~> 'foo'::text UNION SELECT 1 ~> 12 ORDER BY arrowop; CREATE TABLE kv (     pair pair ); INSERT INTO kv VALUES('foo' ~> 'bar'), (1 ~> 2); SELECT (pair).k, (pair).v FROM kv ORDER BY (pair).k; SELECT (pair('foo', 'bar')).k, (pair('foo', 'bar')).v; SELECT ('foo' ~> 'bar').k, ('foo' ~> 'bar').v; ROLLBACK; test/sql/base.sql

138. %

139. %   psql ‐d try ‐Xf test/sql/base.sql BEGIN     pair     ‐‐‐‐‐‐‐‐‐‐‐‐  (1,12)  (12.3,foo)  (HEY,bar)  (foo,1)  (foo,bar)  (foo,woah)  (ick,foo) (7 rows)   arrowop    ‐‐‐‐‐‐‐‐‐‐‐‐  (1,12)  (12.3,foo)  (HEY,bar)  (foo,1)  (foo,bar)  (foo,woah)  (ick,foo) (7 rows) CREATE TABLE INSERT 0 2   k  |  v   ‐‐‐‐‐+‐‐‐‐‐  1   | 2  foo | bar (2 rows)   k  |  v   ‐‐‐‐‐+‐‐‐‐‐  foo | bar We’re golden! (1 row)   k  |  v   ‐‐‐‐‐+‐‐‐‐‐  foo | bar (1 row) ROLLBACK %

140. Remember This? % 

141. Remember This? %    make installcheck pg_regress ‐‐psqldir=/pgsql/bin ‐‐inputdir=test base === dropping database "regression"  === DROP DATABASE === creating database "regression"  === CREATE DATABASE ALTER DATABASE === running regression test queries === test base                 ... diff:   test/expected/base.out: No such file or directory diff command failed with status 512:   diff  "test/expected/base.out" "results/base.out" >  "results/base.out.diff" make: *** [installcheck] Error 2 %

142. Let’s Fix That % 

143. Let’s Fix That %    echo 'set ECHO 0' > test/expected/base.out  %

144. Let’s Fix That %    echo 'set ECHO 0' > test/expected/base.out    psql ‐d try ‐Xf test/sql/base.sql  %   | grep ‐v ^BEGIN >> test/expected/base.out %

145. Let’s Fix That %    echo 'set ECHO 0' > test/expected/base.out    psql ‐d try ‐Xf test/sql/base.sql  %   | grep ‐v ^BEGIN >> test/expected/base.out   % make installcheck pg_regress ‐‐psqldir=/pgsql/bin ‐‐inputdir=test base (using postmaster on Unix socket, default port) ============== dropping database "regression"          ============== DROP DATABASE ============== creating database "regression"          ============== CREATE DATABASE ALTER DATABASE ============== running regression test queries         ============== test base                 ... ok =====================  All 1 tests passed.  =====================

146. Let’s Fix That %    echo 'set ECHO 0' > test/expected/base.out    psql ‐d try ‐Xf test/sql/base.sql  %   | grep ‐v ^BEGIN >> test/expected/base.out   % make installcheck pg_regress ‐‐psqldir=/pgsql/bin ‐‐inputdir=test base (using postmaster on Unix socket, default port) ============== dropping database "regression"          ============== DROP DATABASE ============== creating database "regression"          ============== CREATE DATABASE ALTER DATABASE ============== running regression test queries         ============== test base                 ... ok =====================  All 1 tests passed.  ===================== Woo hoo!

147. Where are We? Stub source, test, and doc files Create the Makefile Write the tests Write the code Write the docs Create the metadata file Package it up Release

148. Where are We? ✔ Stub source, test, and doc files Create the Makefile Write the tests Write the code Write the docs Create the metadata file Package it up Release

149. Where are We? ✔ Stub source, test, and doc files ✔ Create the Makefile Write the tests Write the code Write the docs Create the metadata file Package it up Release

150. Where are We? ✔ Stub source, test, and doc files ✔ Create the Makefile ✔ Write the tests Write the code Write the docs Create the metadata file Package it up Release

151. Where are We? ✔ Stub source, test, and doc files ✔ Create the Makefile ✔ Write the tests ✔ Write the code Write the docs Create the metadata file Package it up Release

152. Write the Docs pair 0.1.0 ========== Synopsis ‐‐‐‐‐‐‐‐     ‐‐ Example code here. Description ‐‐‐‐‐‐‐‐‐‐‐ This library blah blah blah... Usage ‐‐‐‐‐ Here's how to use this library. Author ‐‐‐‐‐‐ [David E. Wheeler](http://justatheory.com/) Copyright ‐‐‐‐‐‐‐‐‐ Copyright (c) 2010 David E. Wheeler. test/sql/base.sql

153. Write the Docs pair 0.1.0 ========== Synopsis ‐‐‐‐‐‐‐‐     % CREATE EXTENSION pair;     CREATE EXTENSION     % SELECT pair('foo', 'bar');         pair     ‐‐‐‐‐‐‐‐‐‐‐‐      (foo,bar)     % SELECT 'foo' ~> 'bar';         pair     ‐‐‐‐‐‐‐‐‐‐‐‐      (foo,bar) Description ‐‐‐‐‐‐‐‐‐‐‐ This library blah blah blah... Usage ‐‐‐‐‐ Here's how to use this library. Author test/sql/base.sql ‐‐‐‐‐‐

154. Write the Docs Description ‐‐‐‐‐‐‐‐‐‐‐ This library blah blah blah... Usage ‐‐‐‐‐ Here's how to use this library. Author ‐‐‐‐‐‐ [David E. Wheeler](http://justatheory.com/) Copyright ‐‐‐‐‐‐‐‐‐ Copyright (c) 2010 David E. Wheeler. test/sql/base.sql

155. Write the Docs Description ‐‐‐‐‐‐‐‐‐‐‐ This library contains a single PostgreSQL extension, a key/value pair data type called `pair`, along with a convenience function for constructing key/value pairs. It's just a simple thing, really: a two‐value composite type that can store any type of value in its slots, which are named `k` and `v`. Usage ‐‐‐‐‐ Here's how to use this library. Author ‐‐‐‐‐‐ [David E. Wheeler](http://justatheory.com/) Copyright ‐‐‐‐‐‐‐‐‐ Copyright (c) 2010 David E. Wheeler. test/sql/base.sql

156. META.json META.json

157. META.json {    "name":       "pair",    "abstract":   "A key/value pair data type",    "version":    "0.1.0",    "maintainer": "Tom Lane <tgl@postgresql.org>",    "license":    "postgresql",    "provides": {       "pair": {          "file":     "pair.sql",          "version":  "0.1.0"       }    },    "meta‐spec":  {       "version": "1.0.0",       "url": "http://pgxn.org/meta/spec.txt"    } } META.json

161. META.json { semver.org    "name":       "pair",    "abstract":   "A key/value pair data type",    "version":    "0.1.0",    "maintainer": "Tom Lane <tgl@postgresql.org>",    "license":    "postgresql",    "provides": {       "pair": {          "file":     "pair.sql",          "version":  "0.1.0"       }    },    "meta‐spec":  {       "version": "1.0.0",       "url": "http://pgxn.org/meta/spec.txt"    } } META.json

166. META.json {    "name":       "pair",    "abstract":   "A key/value pair data type",    "version":    "0.1.0",    "maintainer": "Tom Lane <tgl@postgresql.org>",    "license":    "postgresql",    "provides": {       "pair": {          "file":     "pair.sql",          "version":  "0.1.0"       }    },    "meta‐spec":  {       "version": "1.0.0",       "url": "http://pgxn.org/meta/spec.txt" At least this…    } } META.json

167. Package it Up! % 

168. Package it Up! %    git archive ‐‐format zip ‐‐prefix=pair‐0.1.0/    ‐‐output ~/Desktop/pair‐0.1.0.zip master %

169. Package it Up! %    git archive ‐‐format zip ‐‐prefix=pair‐0.1.0/    ‐‐output ~/Desktop/pair‐0.1.0.zip master % Easy, eh?

170. Where are We? ✔ Stub source, test, and doc files ✔ Create the Makefile ✔ Write the tests ✔ Write the code Write the docs Create the metadata file Package it up Release

171. Where are We? ✔ Stub source, test, and doc files ✔ Create the Makefile ✔ Write the tests ✔ Write the code ✔ Write the docs Create the metadata file Package it up Release

172. Where are We? ✔ Stub source, test, and doc files ✔ Create the Makefile ✔ Write the tests ✔ Write the code ✔ Write the docs ✔ Create the metadata file Package it up Release

173. Where are We? ✔ Stub source, test, and doc files ✔ Create the Makefile ✔ Write the tests ✔ Write the code ✔ Write the docs ✔ Create the metadata file ✔ Package it up Release

177. Tom Lane tgl@postgresql.org http://postgresql.org/~tgl/ tomlane @tomlane I’ve got some killer extensions in development that I think will be useful to everyone, including: * pair: an ordered pair data type * PL/Brainfuck: just what it sounds like

178. Tom Lane tgl@postgresql.org http://postgresql.org/~tgl/ tomlane @tomlane I’ve got some killer extensions in development that I think will be useful to everyone, including: * pair: an ordered pair data type * PL/Brainfuck: just what it sounds like

179. tomlane

183. omg WTF ROTFL lolz omg WTF ROTFL lolz

184. omg WTF ROTFL lolz omg WTF ROTFL lolz

187. tomlane ●●●●●●●●●●●●●●●●●●

195. tomlane

196. tomlane

197. META.json

198. {    "name": "pair",    "abstract": "A key/value pair data type",    "description": "This library contains a single PostgreSQL extension, a key/value    "version": "0.1.0",    "maintainer": "Tom Lane <tgl@postgresql.org>",    "license": "postgresql",    "provides": {       "pair": {          "file": "sql/pair.sql",          "version": "0.1.0"       }    },    "resources": {       "bugtracker": {          "web": "http://github.com/tgl/kv‐pair/issues/"       },       "repository": {         "url":  "git://github.com/tgl/kv‐pair.git",         "web":  "http://github.com/tgl/kv‐pair/",         "type": "git"       }    },    "generated_by": "Tom Lane",    "meta‐spec": {       "version": "1.0.0",       "url": "http://pgxn.org/meta/spec.txt"    },    "tags": [       "variadic function", "ordered pair", "pair", "key value", "key value pair"    ] } META.json

203. Where are We? ✔ Stub source, test, and doc files ✔ Create the Makefile ✔ Write the tests ✔ Write the code ✔ Write the docs ✔ Create the metadata file ✔ Package it up Release

204. Where are We? ✔ Stub source, test, and doc files ✔ Create the Makefile ✔ Write the tests ✔ Write the code ✔ Write the docs ✔ Create the metadata file ✔ Package it up ✔ Release

205. Why PGXN?

206. Why PGXN? World-wide network of mirrors

207. Why PGXN? World-wide network of mirrors Fully indexed extensions

208. Why PGXN? World-wide network of mirrors Fully indexed extensions RESTful metadata distribution

209. Why PGXN? World-wide network of mirrors Fully indexed extensions RESTful metadata distribution Search and documentation site

210. Why PGXN? World-wide network of mirrors Fully indexed extensions RESTful metadata distribution Search and documentation site Comprehensive REST API

211. Why PGXN? World-wide network of mirrors Fully indexed extensions RESTful metadata distribution Search and documentation site Comprehensive REST API Command-line client

213. pair

214. pair

218. PGXN Client %

219. PGXN Client %   sudo easy_install pgxnclient Installing pgxncli.py script to /usr/local/bin Installing pgxn script to /usr/local/bin Processing dependencies for pgxnclient Finished processing dependencies for pgxnclient %

220. PGXN Client %   sudo easy_install pgxnclient Installing pgxncli.py script to /usr/local/bin Installing pgxn script to /usr/local/bin Processing dependencies for pgxnclient Finished processing dependencies for pgxnclient   pgxn install pair % INFO: best version: pair 0.1.3 INFO: saving /tmp/pair‐0.1.3.zip INFO: unpacking: /tmp/pair‐0.1.3.zip INFO: building extension INFO: installing extension %

221. PGXN Client %   sudo easy_install pgxnclient Installing pgxncli.py script to /usr/local/bin Installing pgxn script to /usr/local/bin Processing dependencies for pgxnclient Finished processing dependencies for pgxnclient   pgxn install pair % INFO: best version: pair 0.1.3 INFO: saving /tmp/pair‐0.1.3.zip INFO: unpacking: /tmp/pair‐0.1.3.zip INFO: building extension INFO: installing extension %

222. PGXN Client %   sudo easy_install pgxnclient Installing pgxncli.py script to /usr/local/bin Installing pgxn script to /usr/local/bin Processing dependencies for pgxnclient Finished processing dependencies for pgxnclient   pgxn install pair % INFO: best version: pair 0.1.3 INFO: saving /tmp/pair‐0.1.3.zip INFO: unpacking: /tmp/pair‐0.1.3.zip INFO: building extension INFO: installing extension   % pgxn load pair ‐d try   INFO: best version: pair 0.1.3 CREATE TYPE CREATE FUNCTION CREATE OPERATOR %

223. Thank you Daniele Varrazzo

224. Coming in 9.1

225. Coming in 9.1 9.1 adding extension support

226. Coming in 9.1 9.1 adding extension support CREATE EXTENSION pair WITH SCHEMA utils;

227. Coming in 9.1 9.1 adding extension support CREATE EXTENSION pair WITH SCHEMA utils; Encapsulates dump/restore

228. Coming in 9.1 9.1 adding extension support CREATE EXTENSION pair WITH SCHEMA utils; Encapsulates dump/restore Whatever is deﬁned in the SQL script

229. Coming in 9.1 9.1 adding extension support CREATE EXTENSION pair WITH SCHEMA utils; Encapsulates dump/restore Whatever is deﬁned in the SQL script Supporting it is easy

230. 9.1 Extension Packaging

231. 9.1 Extension Packaging Control ﬁle

232. 9.1 Extension Packaging Control ﬁle Migration from unpackaged

233. 9.1 Extension Packaging Control ﬁle Migration from unpackaged pair--unpackaged--0.1.0.sql

234. 9.1 Extension Packaging Control ﬁle Migration from unpackaged pair--unpackaged--0.1.0.sql Properly-named SQL script

235. 9.1 Extension Packaging Control ﬁle Migration from unpackaged pair--unpackaged--0.1.0.sql Properly-named SQL script pair--0.1.0.sql

236. Create the control ﬁle pair.control

237. Create the control ﬁle # pair extension comment = 'A key/value pair data type' default_version = '0.1.0' module_pathname = '$libdir/pair' relocatable = true superuser = false pair.control

239. Create the control ﬁle Optional # pair extension comment = 'A key/value pair data type' default_version = '0.1.0' module_pathname = '$libdir/pair' relocatable = true superuser = false pair.control

242. Create the control ﬁle # pair extension For C comment = 'A key/value pair data type' default_version = '0.1.0' code module_pathname = '$libdir/pair' relocatable = true superuser = false pair.control

244. Create the control ﬁle # pair extension Can move comment = 'A key/value pair data type' schemas default_version = '0.1.0' module_pathname = '$libdir/pair' relocatable = true superuser = false pair.control

246. Create the control ﬁle # pair extension comment = 'A key/value pair data type' default_version = '0.1.0' module_pathname = '$libdir/pair' relocatable = true Not required superuser = false to install pair.control

247. Create the control ﬁle # pair extension comment = 'A key/value pair data type' default_version = '0.1.0' module_pathname = '$libdir/pair' relocatable = true superuser = false pair.control pair.control

248. Migration from Unpackaged sql/pair‐‐unpac…

249. Migration from Unpackaged ALTER EXTENSION pair ADD TYPE pair; ALTER EXTENSION pair ADD FUNCTION pair(anyelement, text); ALTER EXTENSION pair ADD FUNCTION pair(text, anyelement); ALTER EXTENSION pair ADD FUNCTION pair(anyelement, anyelement); ALTER EXTENSION pair ADD FUNCTION pair(text, text); ALTER EXTENSION pair ADD OPERATOR ~>(text, anyelement); ALTER EXTENSION pair ADD OPERATOR ~>(anyelement, text); ALTER EXTENSION pair ADD OPERATOR ~>(anyelement, anyelement); ALTER EXTENSION pair ADD OPERATOR ~>(text, text); sql/pair‐‐unpac…

250. Migration from Unpackaged ALTER EXTENSION pair ADD TYPE pair; ALTER EXTENSION pair ADD FUNCTION pair(anyelement, text); ALTER EXTENSION pair ADD FUNCTION pair(text, anyelement); ALTER EXTENSION pair ADD FUNCTION pair(anyelement, anyelement); ALTER EXTENSION pair ADD FUNCTION pair(text, text); ALTER EXTENSION pair ADD OPERATOR ~>(text, anyelement); ALTER EXTENSION pair ADD OPERATOR ~>(anyelement, text); ALTER EXTENSION pair ADD OPERATOR ~>(anyelement, anyelement); ALTER EXTENSION pair ADD OPERATOR ~>(text, text); sql/pair--unpackaged--0.1.0.sql sql/pair‐‐unpac…

251. Update the Makeﬁle Makefile

252. Update the Makeﬁle EXTENSION    = pair EXTVERSION   = $(shell grep default_version    $(EXTENSION).control |  sed ‐e    "s/default_version[ ]*=[ ]*'([^']*)'/1/") DATA         = $(filter‐out $(wildcard sql/*‐‐*.sql),$ (wildcard sql/*.sql)) DOCS         = $(wildcard doc/*.*) TESTS        = $(wildcard test/sql/*.sql) REGRESS      = $(patsubst test/sql/%.sql,%,$(TESTS)) REGRESS_OPTS = ‐‐inputdir=test MODULES      = $(patsubst %.c,%,$(wildcard src/*.c)) PG_CONFIG    = pg_config PG91  = $(shell $(PG_CONFIG) ‐‐version    | grep ‐qE " 8.| 9.0" && echo no || echo yes) Makefile

255. Update the Makeﬁle Extract from EXTENSION    = pair EXTVERSION   = $(shell grep default_version  control ﬁle   $(EXTENSION).control |  sed ‐e    "s/default_version[ ]*=[ ]*'([^']*)'/1/") DATA         = $(filter‐out $(wildcard sql/*‐‐*.sql),$ (wildcard sql/*.sql)) DOCS         = $(wildcard doc/*.*) TESTS        = $(wildcard test/sql/*.sql) REGRESS      = $(patsubst test/sql/%.sql,%,$(TESTS)) REGRESS_OPTS = ‐‐inputdir=test MODULES      = $(patsubst %.c,%,$(wildcard src/*.c)) PG_CONFIG    = pg_config PG91  = $(shell $(PG_CONFIG) ‐‐version    | grep ‐qE " 8.| 9.0" && echo no || echo yes) Makefile

258. Update the Makeﬁle PG91  = $(shell $(PG_CONFIG) ‐‐version    | grep ‐qE " 8.| 9.0" && echo no || echo yes) Makefile

259. Update the Makeﬁle PG91  = $(shell $(PG_CONFIG) ‐‐version    | grep ‐qE " 8.| 9.0" && echo no || echo yes) ifeq ($(PG91),yes) all: sql/$(EXTENSION)‐‐$(EXTVERSION).sql sql/$(EXTENSION)‐‐$(EXTVERSION).sql: sql/$(EXTENSION).sql   cp $< $@ DATA = $(wildcard sql/*‐‐*.sql) sql/$(EXTENSION)‐‐$ (EXTVERSION).sql EXTRA_CLEAN = sql/$(EXTENSION)‐‐$(EXTVERSION).sql endif PGXS := $(shell $(PG_CONFIG) ‐‐pgxs) include $(PGXS) Makefile

267. Or Forget It

268. Or Forget It Copy Makeﬁle

269. Or Forget It Copy Makeﬁle Edit ﬁrst line

270. Or Forget It Copy Makeﬁle Edit ﬁrst line EXTENSION=pair

271. Or Forget It Copy Makeﬁle Edit ﬁrst line EXTENSION=pair Ignore the rest

272. Or Forget It Copy Makeﬁle Edit ﬁrst line EXTENSION=pair Ignore the rest Better still…

273. Skeleton in the Closet %

274. Skeleton in the Closet %   sudo gem install pgxn_utils Installing ri documentation for pgxn_utils‐0.1.2... Installing RDoc documentation for pgxn_utils‐0.1.2... %

275. Skeleton in the Closet %   sudo gem install pgxn_utils Installing ri documentation for pgxn_utils‐0.1.2... Installing RDoc documentation for pgxn_utils‐0.1.2...   pgxn_utils skeleton semver %       create  semver       create  semver/semver.control       create  semver/META.json       create  semver/Makefile       create  semver/README.md       create  semver/doc/semver.md       create  semver/sql/semver.sql       create  semver/sql/uninstall_semver.sql       create  semver/test/expected/base.out       create  semver/test/sql/base.sql %

276. Thank you Dickson S. Guedes

277. Install Extension %

278. Install Extension   pgxn load pair ‐d try % INFO: best version: pair 0.1.2 CREATE EXTENSION % Nice.

279. Resources

280. Resources http:/ /pgxn.org/ — Browse

281. Resources http:/ /pgxn.org/ — Browse http:/ /manager.pgxn.org/ — Release

282. Resources http:/ /pgxn.org/ — Browse http:/ /manager.pgxn.org/ — Release http:/ /s.coop/pgextdocs — Learn

283. Resources http:/ /pgxn.org/ — Browse http:/ /manager.pgxn.org/ — Release http:/ /s.coop/pgextdocs — Learn http:/ /s.coop/4y4 — Slides

284. Resources http:/ /pgxn.org/ — Browse http:/ /manager.pgxn.org/ — Release http:/ /s.coop/pgextdocs — Learn http:/ /s.coop/4y4 — Slides http:/ /s.coop/pgxnclient — Client

285. Resources http:/ /pgxn.org/ — Browse http:/ /manager.pgxn.org/ — Release http:/ /s.coop/pgextdocs — Learn http:/ /s.coop/4y4 — Slides http:/ /s.coop/pgxnclient — Client http:/ /s.coop/pgxnutils — Develop

286. Building and Distributing PostgreSQL Extensions Without Learning C David E. Wheeler PostgreSQL Experts, Inc. PGXPUG PgDay 2011 Text: Attribution-Noncommercial-Share Alike 3.0 United States: http://creativecommons.org/licenses/by-nc-sa/3.0/us/ Images licensed independently and © Their respective owners.

Building and Distributing PostgreSQL Extensions Without Learning C

More Related Content

What's hot (20)

Viewers also liked (6)

Similar to Building and Distributing PostgreSQL Extensions Without Learning C (20)

Recently uploaded (20)

Building and Distributing PostgreSQL Extensions Without Learning C

Editor's Notes