{
"name": "pgxn_utils",
"abstract": "pgxn_utils is a development tool to create PostgreSQL extensions",
- "version": "0.1.3",
+ "version": "0.1.4",
"maintainer": "Dickson S. Guedes <guedes@guedesoft.net>",
"license": "postgresql",
"release_status": "stable",
"provides": {
"pgxn_utils": {
"file": "pgxn_utils",
- "version": "0.1.3"
+ "version": "0.1.4"
}
},
"meta-spec": {
def change(extension_name=".")
extension_path, extension_name = resolve_extension_path_and_name(extension_name)
+ template_type = File.read("#{extension_path}/.template").chomp
+
self.target = extension_path
self.extension_name = extension_name
set_accessors(extension_name)
if is_extension?(extension_path)
- template "root/META.json.tt", "#{extension_path}/META.json"
- template "root/%extension_name%.control.tt", "#{extension_path}/%extension_name%.control"
+ template "#{template_type}/META.json.tt", "#{extension_path}/META.json"
+ template "#{template_type}/%extension_name%.control.tt", "#{extension_path}/%extension_name%.control"
else
say "'#{extension_name}' doesn't appears to be an extension. Please, supply the extension's name", :red
end
--- /dev/null
+# <%= extension_name %> extension
+comment = '<%= abstract %>'
+default_version = '<%= version %>'
+relocatable = true
--- /dev/null
+results/
+*.so
+tmp/
+*.o
+regression.diffs
+regression.out
+/sql/<%= extension_name =>--*
+!/sql/<%= extension_name =>--*--*.sql
--- /dev/null
+{
+ "name": "<%= extension_name %>",
+ "abstract": "<%= abstract %>",
+ "description": "<%= description %>",
+ "version": "<%= version %>",
+ "maintainer": "<%= maintainer %>",
+ "license": "<%= license %>",
+ "provides": {
+ "<%= extension_name %>": {
+ "abstract": "<%= abstract %>",
+ "file": "sql/<%= extension_name %>.sql",
+ "docfile": "doc/<%= extension_name %>.md",
+ "version": "<%= version %>"
+ }
+ },
+ "release_status": "<%= release_status %>",
+<% if generated_by %>
+ "generated_by": "<%= generated_by %>",
+<% end %>
+<% if tags %>
+ "tags": [ <%= tags.collect { |t| %Q|"#{t}"| }.join(",") %> ],
+<% end %>
+ "meta-spec": {
+ "version": "1.0.0",
+ "url": "http://pgxn.org/meta/spec.txt"
+ }
+}
--- /dev/null
+EXTENSION = <%= extension_name %>
+EXTVERSION = $(shell grep default_version $(EXTENSION).control | sed -e "s/default_version[[:space:]]*=[[:space:]]*'\([^']*\)'/\1/")
+
+DATA = $(filter-out $(wildcard sql/*--*.sql),$(wildcard sql/*.sql))
+DOCS = $(wildcard doc/*.md)
+TESTS = $(wildcard test/sql/*.sql)
+REGRESS = $(patsubst test/sql/%.sql,%,$(TESTS))
+REGRESS_OPTS = --inputdir=test --load-language=plpgsql
+#
+# Uncoment the MODULES line if you are adding C files
+# to your extention.
+#
+#MODULES = $(patsubst %.c,%,$(wildcard src/*.c))
+PG_CONFIG = pg_config
+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)
--- /dev/null
+<%= extension_name %>
+<%= extension_name.gsub(/./,"=") %>
+
+<%= description %>
+
+To build it, just do this:
+
+ make
+ make installcheck
+ make install
+
+If you encounter an error such as:
+
+ "Makefile", line 8: Need an operator
+
+You need to use GNU make, which may well be installed on your system as
+`gmake`:
+
+ gmake
+ gmake install
+ gmake installcheck
+
+If you encounter an error such as:
+
+ make: pg_config: Command not found
+
+Be sure that you have `pg_config` installed and in your path. If you used a
+package management system such as RPM to install PostgreSQL, be sure that the
+`-devel` package is also installed. If necessary tell the build process where
+to find it:
+
+ env PG_CONFIG=/path/to/pg_config make && make installcheck && make install
+
+And finally, if all that fails (and if you're on PostgreSQL 8.1 or lower, it
+likely will), copy the entire distribution directory to the `contrib/`
+subdirectory of the PostgreSQL source tree and try it there without
+`pg_config`:
+
+ env NO_PGXS=1 make && make installcheck && make install
+
+If you encounter an error such as:
+
+ ERROR: must be owner of database regression
+
+You need to run the test suite using a super user, such as the default
+"postgres" super user:
+
+ make installcheck PGUSER=postgres
+
+Once <%= extension_name %> is installed, you can add it to a database. If you're running
+PostgreSQL 9.1.0 or greater, it's a simple as connecting to a database as a
+super user and running:
+
+ CREATE EXTENSION <%= extension_name %>;
+
+If you've upgraded your cluster to PostgreSQL 9.1 and already had <%= extension_name %>
+installed, you can upgrade it to a properly packaged extension with:
+
+ CREATE EXTENSION <%= extension_name %> FROM unpackaged;
+
+For versions of PostgreSQL less than 9.1.0, you'll need to run the
+installation script:
+
+ psql -d mydb -f /path/to/pgsql/share/contrib/<%= extension_name %>.sql
+
+If you want to install <%= extension_name %> and all of its supporting objects into a specific
+schema, use the `PGOPTIONS` environment variable to specify the schema, like
+so:
+
+ PGOPTIONS=--search_path=extensions psql -d mydb -f <%= extension_name %>.sql
+
+Dependencies
+------------
+The `<%= extension_name %>` data type has no dependencies other than PostgreSQL.
+
+Copyright and License
+---------------------
+
+Copyright (c) <%= Time.now.strftime("%Y") %> <%= maintainer %>.
+
--- /dev/null
+<%= extension_name %>
+<%= extension_name.gsub(/./,"=") %>
+
+Synopsis
+--------
+
+ Show a brief synopsis of the extension.
+
+Description
+-----------
+
+<%= description %>
+
+Usage
+-----
+
+ Show usage.
+
+Support
+-------
+
+ There is issues tracker? Github? Put this information here.
+
+Author
+------
+
+[<%= maintainer %>]
+
+Copyright and License
+---------------------
+
+Copyright (c) <%= Time.now.strftime("%Y") %> <%= maintainer %>.
+
--- /dev/null
+/*
+ * Author: <%= maintainer %>
+ * Created at: <%= Time.now %>
+ *
+ */
+
+--
+-- This is a example code genereted automaticaly
+-- by pgxn-utils.
+
+SET client_min_messages = warning;
+
+-- If your extension will create a type you can
+-- do somenthing like this
+CREATE TYPE <%= extension_name %> AS ( a text, b text );
+
+-- Maybe you want to create some function, so you can use
+-- this as an example
+CREATE OR REPLACE FUNCTION <%= extension_name %> (text, text)
+RETURNS <%= extension_name %> LANGUAGE SQL AS 'SELECT ROW($1, $2)::<%= extension_name %>';
+
+-- Sometimes it is common to use special operators to
+-- work with your new created type, you can create
+-- one like the command bellow if it is applicable
+-- to your case
+
+CREATE OPERATOR #? (
+ LEFTARG = text,
+ RIGHTARG = text,
+ PROCEDURE = <%= extension_name %>
+);
--- /dev/null
+/*
+ * Author: <%= maintainer %>
+ * Created at: <%= Time.now %>
+ *
+ */
+
+--
+-- This is a example code genereted automaticaly
+-- by pgxn-utils.
+
+SET client_min_messages = warning;
+
+BEGIN;
+
+-- You can use this statements as
+-- template for your extension.
+
+DROP OPERATOR #? (text, text);
+DROP FUNCTION <%= extension_name %>(text, text);
+DROP TYPE <%= extension_name %> CASCADE;
+COMMIT;
--- /dev/null
+\set ECHO 0
+-- You should write your tests
+SELECT <%= extension_name %>('foo', 'bar');
+ <%= extension_name %>
+<%= '-' * (extension_name.length + 2) %>
+ (foo,bar)
+(1 row)
+
+SELECT 'foo' #? 'bar' AS arrowop;
+ arrowop
+-----------
+ (foo,bar)
+(1 row)
+
+CREATE TABLE ab (
+ a_field <%= extension_name %>
+);
+INSERT INTO ab VALUES('foo' #? 'bar');
+SELECT (a_field).a, (a_field).b FROM ab;
+ a | b
+-----+-----
+ foo | bar
+(1 row)
+
+SELECT (<%= extension_name %>('foo', 'bar')).a;
+ a
+-----
+ foo
+(1 row)
+
+SELECT (<%= extension_name %>('foo', 'bar')).b;
+ b
+-----
+ bar
+(1 row)
+
+SELECT ('foo' #? 'bar').a;
+ a
+-----
+ foo
+(1 row)
+
+SELECT ('foo' #? 'bar').b;
+ b
+-----
+ bar
+(1 row)
+
+ROLLBACK;
--- /dev/null
+\set ECHO 0
+BEGIN;
+\i sql/<%= extension_name %>.sql
+\set ECHO all
+
+-- You should write your tests
+
+SELECT <%= extension_name %>('foo', 'bar');
+
+SELECT 'foo' #? 'bar' AS arrowop;
+
+CREATE TABLE ab (
+ a_field <%= extension_name %>
+);
+
+INSERT INTO ab VALUES('foo' #? 'bar');
+SELECT (a_field).a, (a_field).b FROM ab;
+
+SELECT (<%= extension_name %>('foo', 'bar')).a;
+SELECT (<%= extension_name %>('foo', 'bar')).b;
+
+SELECT ('foo' #? 'bar').a;
+SELECT ('foo' #? 'bar').b;
+
+ROLLBACK;
module PgxnUtils
- VERSION = "0.1.3"
+ VERSION = "0.1.4"
end
projects / pgxn-utils.git / commitdiff