~ubuntu-branches/ubuntu/utopic/pgadmin3/utopic-proposed

FOR <i class="replaceable"><tt>source_encoding</tt></i> TO <i class="replaceable"><tt>dest_encoding</tt></i> FROM <i class="replaceable"><tt>funcname</tt></i></pre>

</div>

<a name="sql-createconversion-description"></a><h2>Description</h2>

<p> <tt class="command">CREATE CONVERSION</tt> defines a new encoding

conversion. Conversion names may be used in the <tt class="function">convert</tt> function

to specify a particular encoding conversion. Also, conversions that

are marked <tt class="literal">DEFAULT</tt> can be used for automatic encoding conversion between

client and server. For this purpose, two conversions, from encoding A to

B <span class="emphasis"><em>and</em></span> from encoding B to A, must be defined.

</p>

<p> To be able to create a conversion, you must have <tt class="literal">EXECUTE</tt> privilege

on the function and <tt class="literal">CREATE</tt> privilege on the destination schema.

</p>

</div>

<a name="id2670798"></a><h2>Parameters</h2>

<dt><span class="term"><tt class="literal">DEFAULT</tt></span></dt>

<dd><p> The <tt class="literal">DEFAULT</tt> clause indicates that this conversion

is the default for this particular source to destination

encoding. There should be only one default encoding in a schema

for the encoding pair.

</p></dd>

<dd><p> The name of the conversion. The conversion name may be

schema-qualified. If it is not, the conversion is defined in the

current schema. The conversion name must be unique within a

schema.

</p></dd>

<dt><span class="term"><i class="replaceable"><tt>source_encoding</tt></i></span></dt>

<dd><p> The source encoding name.

</p></dd>

<dt><span class="term"><i class="replaceable"><tt>dest_encoding</tt></i></span></dt>

<dd><p> The destination encoding name.

</p></dd>

<dt><span class="term"><i class="replaceable"><tt>funcname</tt></i></span></dt>

<dd>

<p> The function used to perform the conversion. The function name may

be schema-qualified. If it is not, the function will be looked

up in the path.

</p>

<p> The function must have the following signature:

</p>

<pre class="programlisting">conv_proc(

integer, -- source encoding ID

integer, -- destination encoding ID

cstring, -- source string (null terminated C string)

cstring, -- destination string (null terminated C string)

integer -- source string length

) RETURNS void;</pre>

<p>

</p>

</dd>

</dl></div>

</div>

<a name="sql-createconversion-notes"></a><h2>Notes</h2>

<p> Use <tt class="command">DROP CONVERSION</tt> to remove user-defined conversions.

</p>

<p> The privileges required to create a conversion may be changed in a future

release.

</p>

</div>

<a name="sql-createconversion-examples"></a><h2>Examples</h2>

<p> To create a conversion from encoding <tt class="literal">UNICODE</tt> to

<tt class="literal">LATIN1</tt> using <tt class="function">myfunc</tt>:

</p>

<pre class="programlisting">CREATE CONVERSION myconv FOR 'UNICODE' TO 'LATIN1' FROM myfunc;</pre>

<p>

</p>

</div>

100

<a name="sql-createconversion-compat"></a><h2>Compatibility</h2>

101

<p> <tt class="command">CREATE CONVERSION</tt>

102

is a <span class="productname">PostgreSQL</span> extension.

103

There is no <tt class="command">CREATE CONVERSION</tt>

104

statement in the SQL standard.

105

</p>

106

</div>

107

108

109

<span class="simplelist"><a href="sql-alterconversion.html">ALTER CONVERSION</a>, <a href="sql-createfunction.html">CREATE FUNCTION</a>, <a href="sql-dropconversion.html">DROP CONVERSION</a></span>

110

</div>

111

</div></body>

112

</html>

Older »