begriffs open source - ai-pg/blob - full-docs/src/sgml/html/ecpg-sql-type.html

   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>TYPE</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="ecpg-sql-set-descriptor.html" title="SET DESCRIPTOR" /><link rel="next" href="ecpg-sql-var.html" title="VAR" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">TYPE</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="ecpg-sql-set-descriptor.html" title="SET DESCRIPTOR">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="ecpg-sql-commands.html" title="34.14. Embedded SQL Commands">Up</a></td><th width="60%" align="center">34.14. Embedded SQL Commands</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 18.0 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="ecpg-sql-var.html" title="VAR">Next</a></td></tr></table><hr /></div><div class="refentry" id="ECPG-SQL-TYPE"><div class="titlepage"></div><div class="refnamediv"><h2>TYPE</h2><p>TYPE — define a new data type</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
   3 TYPE <em class="replaceable"><code>type_name</code></em> IS <em class="replaceable"><code>ctype</code></em>
   4 </pre></div><div class="refsect1" id="id-1.7.5.20.17.3"><h2>Description</h2><p>
   5      The <code class="command">TYPE</code> command defines a new C type.  It is
   6      equivalent to putting a <code class="literal">typedef</code> into a declare
   7      section.
   8     </p><p>
   9      This command is only recognized when <code class="command">ecpg</code> is
  10      run with the <code class="option">-c</code> option.
  11     </p></div><div class="refsect1" id="id-1.7.5.20.17.4"><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt id="ECPG-SQL-TYPE-TYPE-NAME"><span class="term"><em class="replaceable"><code>type_name</code></em></span> <a href="#ECPG-SQL-TYPE-TYPE-NAME" class="id_link">#</a></dt><dd><p>
  12         The name for the new type.  It must be a valid C type name.
  13        </p></dd><dt id="ECPG-SQL-TYPE-CTYPE"><span class="term"><em class="replaceable"><code>ctype</code></em></span> <a href="#ECPG-SQL-TYPE-CTYPE" class="id_link">#</a></dt><dd><p>
  14         A C type specification.
  15        </p></dd></dl></div></div><div class="refsect1" id="id-1.7.5.20.17.5"><h2>Examples</h2><pre class="programlisting">
  16 EXEC SQL TYPE customer IS
  17     struct
  18     {
  19         varchar name[50];
  20         int     phone;
  21     };
  22
  23 EXEC SQL TYPE cust_ind IS
  24     struct ind
  25     {
  26         short   name_ind;
  27         short   phone_ind;
  28     };
  29
  30 EXEC SQL TYPE c IS char reference;
  31 EXEC SQL TYPE ind IS union { int integer; short smallint; };
  32 EXEC SQL TYPE intarray IS int[AMOUNT];
  33 EXEC SQL TYPE str IS varchar[BUFFERSIZ];
  34 EXEC SQL TYPE string IS char[11];
  35 </pre><p>
  36      Here is an example program that uses <code class="command">EXEC SQL
  37      TYPE</code>:
  38 </p><pre class="programlisting">
  39 EXEC SQL WHENEVER SQLERROR SQLPRINT;
  40
  41 EXEC SQL TYPE tt IS
  42     struct
  43     {
  44         varchar v[256];
  45         int     i;
  46     };
  47
  48 EXEC SQL TYPE tt_ind IS
  49     struct ind {
  50         short   v_ind;
  51         short   i_ind;
  52     };
  53
  54 int
  55 main(void)
  56 {
  57 EXEC SQL BEGIN DECLARE SECTION;
  58     tt t;
  59     tt_ind t_ind;
  60 EXEC SQL END DECLARE SECTION;
  61
  62     EXEC SQL CONNECT TO testdb AS con1;
  63     EXEC SQL SELECT pg_catalog.set_config('search_path', '', false); EXEC SQL COMMIT;
  64
  65     EXEC SQL SELECT current_database(), 256 INTO :t:t_ind LIMIT 1;
  66
  67     printf("t.v = %s\n", t.v.arr);
  68     printf("t.i = %d\n", t.i);
  69
  70     printf("t_ind.v_ind = %d\n", t_ind.v_ind);
  71     printf("t_ind.i_ind = %d\n", t_ind.i_ind);
  72
  73     EXEC SQL DISCONNECT con1;
  74
  75     return 0;
  76 }
  77 </pre><p>
  78
  79      The output from this program looks like this:
  80 </p><pre class="screen">
  81 t.v = testdb
  82 t.i = 256
  83 t_ind.v_ind = 0
  84 t_ind.i_ind = 0
  85 </pre><p>
  86     </p></div><div class="refsect1" id="id-1.7.5.20.17.6"><h2>Compatibility</h2><p>
  87      The <code class="command">TYPE</code> command is a PostgreSQL extension.
  88     </p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ecpg-sql-set-descriptor.html" title="SET DESCRIPTOR">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ecpg-sql-commands.html" title="34.14. Embedded SQL Commands">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ecpg-sql-var.html" title="VAR">Next</a></td></tr><tr><td width="40%" align="left" valign="top">SET DESCRIPTOR </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 18.0 Documentation">Home</a></td><td width="40%" align="right" valign="top"> VAR</td></tr></table></div></body></html>