reconstruct DDL statements for various global database objects.
Each function returns a set of text rows, one SQL statement per row.
(This is a decompiled reconstruction, not the original text of the
- command.) Functions that accept <literal>VARIADIC</literal> options
- take alternating name/value text pairs; values are parsed as boolean,
- integer or text.
+ command.)
</para>
<table id="functions-get-object-ddl-table">
</indexterm>
<function>pg_get_role_ddl</function>
( <parameter>role</parameter> <type>regrole</type>
- <optional>, <literal>VARIADIC</literal> <parameter>options</parameter>
- <type>text[]</type> </optional> )
+ <optional>, <parameter>pretty</parameter> <type>boolean</type>
+ <literal>DEFAULT</literal> false</optional>
+ <optional>, <parameter>memberships</parameter> <type>boolean</type>
+ <literal>DEFAULT</literal> true</optional> )
<returnvalue>setof text</returnvalue>
</para>
<para>
<command>ALTER ROLE ... SET</command> statements for the given role.
Each statement is returned as a separate row.
Password information is never included in the output.
- The following options are supported: <literal>pretty</literal> (boolean)
- for pretty-printed output and <literal>memberships</literal> (boolean,
- default true) to include <command>GRANT</command> statements for
- role memberships and their options.
+ When <parameter>pretty</parameter> is true, the output is
+ pretty-printed. When <parameter>memberships</parameter> is false,
+ <command>GRANT</command> statements for role memberships are
+ omitted.
</para></entry>
</row>
<row>
</indexterm>
<function>pg_get_tablespace_ddl</function>
( <parameter>tablespace</parameter> <type>oid</type>
- <optional>, <literal>VARIADIC</literal> <parameter>options</parameter>
- <type>text[]</type> </optional> )
+ <optional>, <parameter>pretty</parameter> <type>boolean</type>
+ <literal>DEFAULT</literal> false</optional>
+ <optional>, <parameter>owner</parameter> <type>boolean</type>
+ <literal>DEFAULT</literal> true</optional> )
<returnvalue>setof text</returnvalue>
</para>
<para role="func_signature">
<function>pg_get_tablespace_ddl</function>
( <parameter>tablespace</parameter> <type>name</type>
- <optional>, <literal>VARIADIC</literal> <parameter>options</parameter>
- <type>text[]</type> </optional> )
+ <optional>, <parameter>pretty</parameter> <type>boolean</type>
+ <literal>DEFAULT</literal> false</optional>
+ <optional>, <parameter>owner</parameter> <type>boolean</type>
+ <literal>DEFAULT</literal> true</optional> )
<returnvalue>setof text</returnvalue>
</para>
<para>
the specified tablespace (by OID or name). If the tablespace has
options set, an <command>ALTER TABLESPACE ... SET</command> statement
is also returned. Each statement is returned as a separate row.
- The following options are supported: <literal>pretty</literal> (boolean)
- for formatted output and <literal>owner</literal> (boolean) to include
- <literal>OWNER</literal>.
+ When <parameter>pretty</parameter> is true, the output is
+ pretty-printed. When <parameter>owner</parameter> is false, the
+ <literal>OWNER</literal> clause is omitted.
</para></entry>
</row>
<row>
</indexterm>
<function>pg_get_database_ddl</function>
( <parameter>database</parameter> <type>regdatabase</type>
- <optional>, <literal>VARIADIC</literal> <parameter>options</parameter>
- <type>text[]</type> </optional> )
+ <optional>, <parameter>pretty</parameter> <type>boolean</type>
+ <literal>DEFAULT</literal> false</optional>
+ <optional>, <parameter>owner</parameter> <type>boolean</type>
+ <literal>DEFAULT</literal> true</optional>
+ <optional>, <parameter>tablespace</parameter> <type>boolean</type>
+ <literal>DEFAULT</literal> true</optional> )
<returnvalue>setof text</returnvalue>
</para>
<para>
specified database, followed by <command>ALTER DATABASE</command>
statements for connection limit, template status, and configuration
settings. Each statement is returned as a separate row.
- The following options are supported:
- <literal>pretty</literal> (boolean) for formatted output,
- <literal>owner</literal> (boolean) to include <literal>OWNER</literal>,
- and <literal>tablespace</literal> (boolean) to include
- <literal>TABLESPACE</literal>.
+ When <parameter>pretty</parameter> is true, the output is
+ pretty-printed. When <parameter>owner</parameter> is false, the
+ <literal>OWNER</literal> clause is omitted. When
+ <parameter>tablespace</parameter> is false, the
+ <literal>TABLESPACE</literal> clause is omitted.
</para></entry>
</row>
</tbody>
#include "mb/pg_wchar.h"
#include "miscadmin.h"
#include "utils/acl.h"
-#include "utils/array.h"
#include "utils/builtins.h"
#include "utils/datetime.h"
#include "utils/fmgroids.h"
#include "utils/timestamp.h"
#include "utils/varlena.h"
-/* Option value types for DDL option parsing */
-typedef enum
-{
- DDL_OPT_BOOL,
- DDL_OPT_TEXT,
- DDL_OPT_INT,
-} DdlOptType;
-
-/*
- * A single DDL option descriptor: caller fills in name and type,
- * parse_ddl_options fills in isset + the appropriate value field.
- */
-typedef struct DdlOption
-{
- const char *name; /* option name (case-insensitive match) */
- DdlOptType type; /* expected value type */
- bool isset; /* true if caller supplied this option */
- /* fields for specific option types */
- union
- {
- bool boolval; /* filled in for DDL_OPT_BOOL */
- char *textval; /* filled in for DDL_OPT_TEXT (palloc'd) */
- int intval; /* filled in for DDL_OPT_INT */
- };
-} DdlOption;
-
-
-static void parse_ddl_options(FunctionCallInfo fcinfo, int variadic_start,
- DdlOption *opts, int nopts);
static void append_ddl_option(StringInfo buf, bool pretty, int indent,
const char *fmt, ...)
pg_attribute_printf(4, 5);
static List *pg_get_role_ddl_internal(Oid roleid, bool pretty,
bool memberships);
static List *pg_get_tablespace_ddl_internal(Oid tsid, bool pretty, bool no_owner);
-static Datum pg_get_tablespace_ddl_srf(FunctionCallInfo fcinfo, Oid tsid, bool isnull);
+static Datum pg_get_tablespace_ddl_srf(FunctionCallInfo fcinfo, Oid tsid);
static List *pg_get_database_ddl_internal(Oid dbid, bool pretty,
bool no_owner, bool no_tablespace);
-/*
- * parse_ddl_options
- * Parse variadic name/value option pairs
- *
- * Options are passed as alternating key/value text pairs. The caller
- * provides an array of DdlOption descriptors specifying the accepted
- * option names and their types; this function matches each supplied
- * pair against the array, validates the value, and fills in the
- * result fields.
- */
-static void
-parse_ddl_options(FunctionCallInfo fcinfo, int variadic_start,
- DdlOption *opts, int nopts)
-{
- Datum *args;
- bool *nulls;
- Oid *types;
- int nargs;
-
- /* Clear all output fields */
- for (int i = 0; i < nopts; i++)
- {
- opts[i].isset = false;
- switch (opts[i].type)
- {
- case DDL_OPT_BOOL:
- opts[i].boolval = false;
- break;
- case DDL_OPT_TEXT:
- opts[i].textval = NULL;
- break;
- case DDL_OPT_INT:
- opts[i].intval = 0;
- break;
- }
- }
-
- nargs = extract_variadic_args(fcinfo, variadic_start, true,
- &args, &types, &nulls);
-
- if (nargs <= 0)
- return;
-
- /* Handle DEFAULT NULL case */
- if (nargs == 1 && nulls[0])
- return;
-
- if (nargs % 2 != 0)
- ereport(ERROR,
- (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
- errmsg("variadic arguments must be name/value pairs"),
- errhint("Provide an even number of variadic arguments that can be divided into pairs.")));
-
- /*
- * For each option name/value pair, find corresponding positional option
- * for the option name, and assign the option value.
- */
- for (int i = 0; i < nargs; i += 2)
- {
- char *name;
- char *valstr;
- DdlOption *opt = NULL;
-
- if (nulls[i])
- ereport(ERROR,
- (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
- errmsg("option name at variadic position %d is null", i + 1)));
-
- name = TextDatumGetCString(args[i]);
-
- if (nulls[i + 1])
- ereport(ERROR,
- (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
- errmsg("value for option \"%s\" must not be null", name)));
-
- /* Find matching option descriptor */
- for (int j = 0; j < nopts; j++)
- {
- if (pg_strcasecmp(name, opts[j].name) == 0)
- {
- opt = &opts[j];
- break;
- }
- }
-
- if (opt == NULL)
- ereport(ERROR,
- (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
- errmsg("unrecognized option: \"%s\"", name)));
-
- if (opt->isset)
- ereport(ERROR,
- (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
- errmsg("option \"%s\" is specified more than once",
- name)));
-
- valstr = TextDatumGetCString(args[i + 1]);
-
- switch (opt->type)
- {
- case DDL_OPT_BOOL:
- if (!parse_bool(valstr, &opt->boolval))
- ereport(ERROR,
- (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
- errmsg("invalid value for boolean option \"%s\": %s",
- name, valstr)));
- break;
-
- case DDL_OPT_TEXT:
- opt->textval = valstr;
- valstr = NULL; /* don't pfree below */
- break;
-
- case DDL_OPT_INT:
- {
- char *endp;
- long val;
-
- errno = 0;
- val = strtol(valstr, &endp, 10);
- if (*endp != '\0' || errno == ERANGE ||
- val < PG_INT32_MIN || val > PG_INT32_MAX)
- ereport(ERROR,
- (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
- errmsg("invalid value for integer option \"%s\": %s",
- name, valstr)));
- opt->intval = (int) val;
- }
- break;
- }
-
- opt->isset = true;
-
- if (valstr)
- pfree(valstr);
- pfree(name);
- }
-}
-
/*
* Helper to append a formatted string with optional pretty-printing.
*/
* Each row is a complete SQL statement. The first row is always the
* CREATE ROLE statement; subsequent rows are ALTER ROLE SET statements
* and optionally GRANT statements for role memberships.
- * Returns no rows if the role argument is NULL.
*/
Datum
pg_get_role_ddl(PG_FUNCTION_ARGS)
{
MemoryContext oldcontext;
Oid roleid;
- DdlOption opts[] = {
- {"pretty", DDL_OPT_BOOL},
- {"memberships", DDL_OPT_BOOL},
- };
+ bool pretty;
+ bool memberships;
funcctx = SRF_FIRSTCALL_INIT();
oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
- if (PG_ARGISNULL(0))
- {
- MemoryContextSwitchTo(oldcontext);
- SRF_RETURN_DONE(funcctx);
- }
-
roleid = PG_GETARG_OID(0);
- parse_ddl_options(fcinfo, 1, opts, lengthof(opts));
+ pretty = PG_GETARG_BOOL(1);
+ memberships = PG_GETARG_BOOL(2);
- statements = pg_get_role_ddl_internal(roleid,
- opts[0].isset && opts[0].boolval,
- !opts[1].isset || opts[1].boolval);
+ statements = pg_get_role_ddl_internal(roleid, pretty, memberships);
funcctx->user_fctx = statements;
funcctx->max_calls = list_length(statements);
* pg_get_tablespace_ddl_srf - common SRF logic for tablespace DDL
*/
static Datum
-pg_get_tablespace_ddl_srf(FunctionCallInfo fcinfo, Oid tsid, bool isnull)
+pg_get_tablespace_ddl_srf(FunctionCallInfo fcinfo, Oid tsid)
{
FuncCallContext *funcctx;
List *statements;
if (SRF_IS_FIRSTCALL())
{
MemoryContext oldcontext;
- DdlOption opts[] = {
- {"pretty", DDL_OPT_BOOL},
- {"owner", DDL_OPT_BOOL},
- };
+ bool pretty;
+ bool no_owner;
funcctx = SRF_FIRSTCALL_INIT();
oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
- if (isnull)
- {
- MemoryContextSwitchTo(oldcontext);
- SRF_RETURN_DONE(funcctx);
- }
-
- parse_ddl_options(fcinfo, 1, opts, lengthof(opts));
+ pretty = PG_GETARG_BOOL(1);
+ no_owner = !PG_GETARG_BOOL(2);
- statements = pg_get_tablespace_ddl_internal(tsid,
- opts[0].isset && opts[0].boolval,
- opts[1].isset && !opts[1].boolval);
+ statements = pg_get_tablespace_ddl_internal(tsid, pretty, no_owner);
funcctx->user_fctx = statements;
funcctx->max_calls = list_length(statements);
Datum
pg_get_tablespace_ddl_oid(PG_FUNCTION_ARGS)
{
- Oid tsid = InvalidOid;
- bool isnull;
-
- isnull = PG_ARGISNULL(0);
- if (!isnull)
- tsid = PG_GETARG_OID(0);
+ Oid tsid = PG_GETARG_OID(0);
- return pg_get_tablespace_ddl_srf(fcinfo, tsid, isnull);
+ return pg_get_tablespace_ddl_srf(fcinfo, tsid);
}
/*
Datum
pg_get_tablespace_ddl_name(PG_FUNCTION_ARGS)
{
- Oid tsid = InvalidOid;
- Name tspname;
- bool isnull;
+ Name tspname = PG_GETARG_NAME(0);
+ Oid tsid = get_tablespace_oid(NameStr(*tspname), false);
- isnull = PG_ARGISNULL(0);
-
- if (!isnull)
- {
- tspname = PG_GETARG_NAME(0);
- tsid = get_tablespace_oid(NameStr(*tspname), false);
- }
-
- return pg_get_tablespace_ddl_srf(fcinfo, tsid, isnull);
+ return pg_get_tablespace_ddl_srf(fcinfo, tsid);
}
/*
{
MemoryContext oldcontext;
Oid dbid;
- DdlOption opts[] = {
- {"pretty", DDL_OPT_BOOL},
- {"owner", DDL_OPT_BOOL},
- {"tablespace", DDL_OPT_BOOL},
- };
+ bool pretty;
+ bool no_owner;
+ bool no_tablespace;
funcctx = SRF_FIRSTCALL_INIT();
oldcontext = MemoryContextSwitchTo(funcctx->multi_call_memory_ctx);
- if (PG_ARGISNULL(0))
- {
- MemoryContextSwitchTo(oldcontext);
- SRF_RETURN_DONE(funcctx);
- }
-
dbid = PG_GETARG_OID(0);
- parse_ddl_options(fcinfo, 1, opts, lengthof(opts));
+ pretty = PG_GETARG_BOOL(1);
+ no_owner = !PG_GETARG_BOOL(2);
+ no_tablespace = !PG_GETARG_BOOL(3);
- statements = pg_get_database_ddl_internal(dbid,
- opts[0].isset && opts[0].boolval,
- opts[1].isset && !opts[1].boolval,
- opts[2].isset && !opts[2].boolval);
+ statements = pg_get_database_ddl_internal(dbid, pretty, no_owner,
+ no_tablespace);
funcctx->user_fctx = statements;
funcctx->max_calls = list_length(statements);
*/
/* yyyymmddN */
-#define CATALOG_VERSION_NO 202606251
+#define CATALOG_VERSION_NO 202606281
#endif
proname => 'pg_get_constraintdef', provolatile => 's', prorettype => 'text',
proargtypes => 'oid bool', prosrc => 'pg_get_constraintdef_ext' },
{ oid => '6501', descr => 'get DDL to recreate a role',
- proname => 'pg_get_role_ddl', prorows => '10', provariadic => 'text',
- proisstrict => 'f', proretset => 't', provolatile => 's',
- pronargdefaults => '1', prorettype => 'text', proargtypes => 'regrole _text',
- proallargtypes => '{regrole,_text}', proargmodes => '{i,v}',
- proargdefaults => '{NULL}', prosrc => 'pg_get_role_ddl' },
+ proname => 'pg_get_role_ddl', prorows => '10', proisstrict => 't',
+ proretset => 't', provolatile => 's', pronargdefaults => '2',
+ prorettype => 'text', proargtypes => 'regrole bool bool',
+ proargnames => '{role,pretty,memberships}',
+ proargdefaults => '{false,true}', prosrc => 'pg_get_role_ddl' },
{ oid => '6499', descr => 'get DDL to recreate a tablespace',
- proname => 'pg_get_tablespace_ddl', prorows => '10', provariadic => 'text',
- proisstrict => 'f', proretset => 't', provolatile => 's',
- pronargdefaults => '1', prorettype => 'text', proargtypes => 'oid _text',
- proallargtypes => '{oid,_text}', proargmodes => '{i,v}',
- proargdefaults => '{NULL}', prosrc => 'pg_get_tablespace_ddl_oid' },
+ proname => 'pg_get_tablespace_ddl', prorows => '10', proisstrict => 't',
+ proretset => 't', provolatile => 's', pronargdefaults => '2',
+ prorettype => 'text', proargtypes => 'oid bool bool',
+ proargnames => '{tablespace,pretty,owner}',
+ proargdefaults => '{false,true}', prosrc => 'pg_get_tablespace_ddl_oid' },
{ oid => '6500', descr => 'get DDL to recreate a tablespace',
- proname => 'pg_get_tablespace_ddl', prorows => '10', provariadic => 'text',
- proisstrict => 'f', proretset => 't', provolatile => 's',
- pronargdefaults => '1', prorettype => 'text', proargtypes => 'name _text',
- proallargtypes => '{name,_text}', proargmodes => '{i,v}',
- proargdefaults => '{NULL}', prosrc => 'pg_get_tablespace_ddl_name' },
+ proname => 'pg_get_tablespace_ddl', prorows => '10', proisstrict => 't',
+ proretset => 't', provolatile => 's', pronargdefaults => '2',
+ prorettype => 'text', proargtypes => 'name bool bool',
+ proargnames => '{tablespace,pretty,owner}',
+ proargdefaults => '{false,true}', prosrc => 'pg_get_tablespace_ddl_name' },
{ oid => '6502', descr => 'get DDL to recreate a database',
- proname => 'pg_get_database_ddl', prorows => '10', provariadic => 'text',
- proisstrict => 'f', proretset => 't', provolatile => 's',
- pronargdefaults => '1', prorettype => 'text',
- proargtypes => 'regdatabase _text', proallargtypes => '{regdatabase,_text}',
- proargmodes => '{i,v}', proargdefaults => '{NULL}',
- prosrc => 'pg_get_database_ddl' },
+ proname => 'pg_get_database_ddl', prorows => '10', proisstrict => 't',
+ proretset => 't', provolatile => 's', pronargdefaults => '3',
+ prorettype => 'text', proargtypes => 'regdatabase bool bool bool',
+ proargnames => '{database,pretty,owner,tablespace}',
+ proargdefaults => '{false,true,true}', prosrc => 'pg_get_database_ddl' },
{ oid => '2509',
descr => 'deparse an encoded expression with pretty-print option',
proname => 'pg_get_expr', provolatile => 's', prorettype => 'text',
# Pretty-printed output
$result = $node->safe_psql('postgres',
- q{SELECT * FROM pg_get_role_ddl('regress_role_ddl_test2', 'pretty', 'true')}
+ q{SELECT * FROM pg_get_role_ddl('regress_role_ddl_test2', pretty => true)}
);
like($result, qr/\n\s+SUPERUSER/, 'role pretty-print indents attributes');
# Memberships suppressed
$result = $node->safe_psql('postgres',
- q{SELECT * FROM pg_get_role_ddl('regress_role_ddl_member', 'memberships', 'false')}
+ q{SELECT * FROM pg_get_role_ddl('regress_role_ddl_member', memberships => false)}
);
unlike($result, qr/GRANT/, 'memberships suppressed');
q{SELECT count(*) FROM pg_get_database_ddl(NULL)});
is($result, '0', 'NULL database returns no rows');
-# Invalid option
+# Invalid option (bad boolean cast)
($ret, $stdout, $stderr) = $node->psql('postgres',
- q{SELECT * FROM pg_get_database_ddl('regression_ddlutils_test', 'owner', 'invalid')}
+ q{SELECT * FROM pg_get_database_ddl('regression_ddlutils_test', owner => 'invalid')}
);
isnt($ret, 0, 'invalid boolean option errors');
-like($stderr, qr/invalid value/, 'invalid option error message');
+like($stderr, qr/invalid input syntax for type boolean/, 'invalid option error message');
-# Duplicate option
+# Duplicate named argument
($ret, $stdout, $stderr) = $node->psql(
'postgres',
q{SELECT * FROM pg_get_database_ddl('regression_ddlutils_test',
- 'owner', 'false', 'owner', 'true')});
+ owner => false, owner => true)});
isnt($ret, 0, 'duplicate option errors');
# Basic output (without locale details)
'postgres',
q{SELECT pg_get_database_ddl
FROM pg_get_database_ddl('regression_ddlutils_test',
- 'pretty', 'true', 'tablespace', 'false')}));
+ pretty => true, tablespace => false)}));
like($result, qr/\n\s+WITH TEMPLATE/, 'database DDL pretty-prints WITH');
+# Owner suppressed
+$result = ddl_filter(
+ $node->safe_psql(
+ 'postgres',
+ q{SELECT pg_get_database_ddl
+ FROM pg_get_database_ddl('regression_ddlutils_test', owner => false)}));
+unlike($result, qr/OWNER/, 'database DDL owner suppressed');
+
# Permission check
$node->safe_psql(
'postgres', q{
$result = $node->safe_psql(
'postgres',
q{SELECT * FROM pg_get_tablespace_ddl('regress_allopt_tblsp',
- 'pretty', 'true')});
+ pretty => true)});
like($result, qr/\n\s+OWNER/, 'tablespace DDL pretty-prints OWNER');
# Owner suppressed
$result = $node->safe_psql(
'postgres',
q{SELECT * FROM pg_get_tablespace_ddl('regress_allopt_tblsp',
- 'owner', 'false')});
+ owner => false)});
unlike($result, qr/OWNER/, 'tablespace DDL owner suppressed');
# Lookup by OID
projects / thirdparty / postgresql.git / commitdiff
