codekingpro/portable-devtools
114k
1<?xml version="1.0" encoding="UTF-8" standalone="no"?>2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>37.33. parameters</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="infoschema-key-column-usage.html" title="37.32. key_column_usage" /><link rel="next" href="infoschema-referential-constraints.html" title="37.34. referential_constraints" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">37.33. <code class="literal">parameters</code></th></tr><tr><td width="10%" align="left"><a accesskey="p" href="infoschema-key-column-usage.html" title="37.32. key_column_usage">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="information-schema.html" title="Chapter 37. The Information Schema">Up</a></td><th width="60%" align="center">Chapter 37. The Information Schema</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 16.3 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="infoschema-referential-constraints.html" title="37.34. referential_constraints">Next</a></td></tr></table><hr /></div><div class="sect1" id="INFOSCHEMA-PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both">37.33. <code class="literal">parameters</code> <a href="#INFOSCHEMA-PARAMETERS" class="id_link">#</a></h2></div></div></div><p>3 The view <code class="literal">parameters</code> contains information about4 the parameters (arguments) of all functions in the current database.5 Only those functions are shown that the current user has access to6 (by way of being the owner or having some privilege).7 </p><div class="table" id="id-1.7.6.37.3"><p class="title"><strong>Table 37.31. <code class="structname">parameters</code> Columns</strong></p><div class="table-contents"><table class="table" summary="parameters Columns" border="1"><colgroup><col /></colgroup><thead><tr><th class="catalog_table_entry"><p class="column_definition">8 Column Type9 </p>10 <p>11 Description12 </p></th></tr></thead><tbody><tr><td class="catalog_table_entry"><p class="column_definition">13 <code class="structfield">specific_catalog</code> <code class="type">sql_identifier</code>14 </p>15 <p>16 Name of the database containing the function (always the current database)17 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">18 <code class="structfield">specific_schema</code> <code class="type">sql_identifier</code>19 </p>20 <p>21 Name of the schema containing the function22 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">23 <code class="structfield">specific_name</code> <code class="type">sql_identifier</code>24 </p>25 <p>26 The <span class="quote">“<span class="quote">specific name</span>”</span> of the function. See <a class="xref" href="infoschema-routines.html" title="37.45. routines">Section 37.45</a> for more information.27 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">28 <code class="structfield">ordinal_position</code> <code class="type">cardinal_number</code>29 </p>30 <p>31 Ordinal position of the parameter in the argument list of the32 function (count starts at 1)33 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">34 <code class="structfield">parameter_mode</code> <code class="type">character_data</code>35 </p>36 <p>37 <code class="literal">IN</code> for input parameter,38 <code class="literal">OUT</code> for output parameter,39 and <code class="literal">INOUT</code> for input/output parameter.40 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">41 <code class="structfield">is_result</code> <code class="type">yes_or_no</code>42 </p>43 <p>44 Applies to a feature not available in <span class="productname">PostgreSQL</span>45 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">46 <code class="structfield">as_locator</code> <code class="type">yes_or_no</code>47 </p>48 <p>49 Applies to a feature not available in <span class="productname">PostgreSQL</span>50 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">51 <code class="structfield">parameter_name</code> <code class="type">sql_identifier</code>52 </p>53 <p>54 Name of the parameter, or null if the parameter has no name55 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">56 <code class="structfield">data_type</code> <code class="type">character_data</code>57 </p>58 <p>59 Data type of the parameter, if it is a built-in type, or60 <code class="literal">ARRAY</code> if it is some array (in that case, see61 the view <code class="literal">element_types</code>), else62 <code class="literal">USER-DEFINED</code> (in that case, the type is63 identified in <code class="literal">udt_name</code> and associated64 columns).65 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">66 <code class="structfield">character_maximum_length</code> <code class="type">cardinal_number</code>67 </p>68 <p>69 Always null, since this information is not applied to parameter data types in <span class="productname">PostgreSQL</span>70 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">71 <code class="structfield">character_octet_length</code> <code class="type">cardinal_number</code>72 </p>73 <p>74 Always null, since this information is not applied to parameter data types in <span class="productname">PostgreSQL</span>75 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">76 <code class="structfield">character_set_catalog</code> <code class="type">sql_identifier</code>77 </p>78 <p>79 Applies to a feature not available in <span class="productname">PostgreSQL</span>80 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">81 <code class="structfield">character_set_schema</code> <code class="type">sql_identifier</code>82 </p>83 <p>84 Applies to a feature not available in <span class="productname">PostgreSQL</span>85 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">86 <code class="structfield">character_set_name</code> <code class="type">sql_identifier</code>87 </p>88 <p>89 Applies to a feature not available in <span class="productname">PostgreSQL</span>90 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">91 <code class="structfield">collation_catalog</code> <code class="type">sql_identifier</code>92 </p>93 <p>94 Always null, since this information is not applied to parameter data types in <span class="productname">PostgreSQL</span>95 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">96 <code class="structfield">collation_schema</code> <code class="type">sql_identifier</code>97 </p>98 <p>99 Always null, since this information is not applied to parameter data types in <span class="productname">PostgreSQL</span>100 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">101 <code class="structfield">collation_name</code> <code class="type">sql_identifier</code>102 </p>103 <p>104 Always null, since this information is not applied to parameter data types in <span class="productname">PostgreSQL</span>105 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">106 <code class="structfield">numeric_precision</code> <code class="type">cardinal_number</code>107 </p>108 <p>109 Always null, since this information is not applied to parameter data types in <span class="productname">PostgreSQL</span>110 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">111 <code class="structfield">numeric_precision_radix</code> <code class="type">cardinal_number</code>112 </p>113 <p>114 Always null, since this information is not applied to parameter data types in <span class="productname">PostgreSQL</span>115 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">116 <code class="structfield">numeric_scale</code> <code class="type">cardinal_number</code>117 </p>118 <p>119 Always null, since this information is not applied to parameter data types in <span class="productname">PostgreSQL</span>120 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">121 <code class="structfield">datetime_precision</code> <code class="type">cardinal_number</code>122 </p>123 <p>124 Always null, since this information is not applied to parameter data types in <span class="productname">PostgreSQL</span>125 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">126 <code class="structfield">interval_type</code> <code class="type">character_data</code>127 </p>128 <p>129 Always null, since this information is not applied to parameter data types in <span class="productname">PostgreSQL</span>130 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">131 <code class="structfield">interval_precision</code> <code class="type">cardinal_number</code>132 </p>133 <p>134 Always null, since this information is not applied to parameter data types in <span class="productname">PostgreSQL</span>135 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">136 <code class="structfield">udt_catalog</code> <code class="type">sql_identifier</code>137 </p>138 <p>139 Name of the database that the data type of the parameter is140 defined in (always the current database)141 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">142 <code class="structfield">udt_schema</code> <code class="type">sql_identifier</code>143 </p>144 <p>145 Name of the schema that the data type of the parameter is146 defined in147 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">148 <code class="structfield">udt_name</code> <code class="type">sql_identifier</code>149 </p>150 <p>151 Name of the data type of the parameter152 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">153 <code class="structfield">scope_catalog</code> <code class="type">sql_identifier</code>154 </p>155 <p>156 Applies to a feature not available in <span class="productname">PostgreSQL</span>157 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">158 <code class="structfield">scope_schema</code> <code class="type">sql_identifier</code>159 </p>160 <p>161 Applies to a feature not available in <span class="productname">PostgreSQL</span>162 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">163 <code class="structfield">scope_name</code> <code class="type">sql_identifier</code>164 </p>165 <p>166 Applies to a feature not available in <span class="productname">PostgreSQL</span>167 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">168 <code class="structfield">maximum_cardinality</code> <code class="type">cardinal_number</code>169 </p>170 <p>171 Always null, because arrays always have unlimited maximum cardinality in <span class="productname">PostgreSQL</span>172 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">173 <code class="structfield">dtd_identifier</code> <code class="type">sql_identifier</code>174 </p>175 <p>176 An identifier of the data type descriptor of the parameter,177 unique among the data type descriptors pertaining to the178 function. This is mainly useful for joining with other179 instances of such identifiers. (The specific format of the180 identifier is not defined and not guaranteed to remain the same181 in future versions.)182 </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">183 <code class="structfield">parameter_default</code> <code class="type">character_data</code>184 </p>185 <p>186 The default expression of the parameter, or null if none or if the187 function is not owned by a currently enabled role.188 </p></td></tr></tbody></table></div></div><br class="table-break" /></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="infoschema-key-column-usage.html" title="37.32. key_column_usage">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="information-schema.html" title="Chapter 37. The Information Schema">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="infoschema-referential-constraints.html" title="37.34. referential_constraints">Next</a></td></tr><tr><td width="40%" align="left" valign="top">37.32. <code class="literal">key_column_usage</code> </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 16.3 Documentation">Home</a></td><td width="40%" align="right" valign="top"> 37.34. <code class="literal">referential_constraints</code></td></tr></table></div></body></html>