<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.mysql-xdevapi-rowresult.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'mysql-xdevapi-rowresult.getcolumns.php',
    1 => 'RowResult::getColumns',
    2 => 'Get column metadata',
  ),
  'up' => 
  array (
    0 => 'class.mysql-xdevapi-rowresult.php',
    1 => 'mysql_xdevapi\\RowResult',
  ),
  'prev' => 
  array (
    0 => 'mysql-xdevapi-rowresult.getcolumnnames.php',
    1 => 'RowResult::getColumnNames',
  ),
  'next' => 
  array (
    0 => 'mysql-xdevapi-rowresult.getwarnings.php',
    1 => 'RowResult::getWarnings',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/mysql_xdevapi/mysql_xdevapi/rowresult/getcolumns.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="mysql-xdevapi-rowresult.getcolumns" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">RowResult::getColumns</h1>
  <p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">RowResult::getColumns</span> &mdash; <span class="dc-title">Get column metadata</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-mysql-xdevapi-rowresult.getcolumns-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>mysql_xdevapi\RowResult::getColumns</strong></span>(): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>

  <p class="para rdfs-comment">
   Retrieve column metadata for columns present in the result set.
  </p>

  <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function is
currently not documented; only its argument list is available.
</p></div>

 </div>


 <div class="refsect1 parameters" id="refsect1-mysql-xdevapi-rowresult.getcolumns-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">This function has no parameters.</p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-mysql-xdevapi-rowresult.getcolumns-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   An array of FieldMetadata objects representing the columns in the result, 
   or an empty array if the result set is empty.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-mysql-xdevapi-rowresult.getcolumns-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-1">
   <p><strong>Example #1 <span class="function"><strong>mysql_xdevapi\RowResult::getColumns()</strong></span> example</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$session </span><span style="color: #007700">= </span><span style="color: #0000BB">mysql_xdevapi\getSession</span><span style="color: #007700">(</span><span style="color: #DD0000">"mysqlx://user:password@localhost"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"DROP DATABASE addressbook"</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"CREATE DATABASE foo"</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"CREATE TABLE foo.test_table(x int)"</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"INSERT INTO addressbook.names values ('John', 42), ('Sam', 33)"</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$sql </span><span style="color: #007700">= </span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"SELECT * from addressbook.names"</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$cols </span><span style="color: #007700">= </span><span style="color: #0000BB">$sql</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getColumns</span><span style="color: #007700">();<br />  <br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$cols</span><span style="color: #007700">);</span></span></code></div>
   </div>

   <div class="example-contents"><p>The above example will output
something similar to:</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">Array
(
    [0] =&gt; mysql_xdevapi\FieldMetadata Object
        (
            [type] =&gt; 7
            [type_name] =&gt; BYTES
            [name] =&gt; name
            [original_name] =&gt; name
            [table] =&gt; names
            [original_table] =&gt; names
            [schema] =&gt; addressbook
            [catalog] =&gt; def
            [collation] =&gt; 255
            [fractional_digits] =&gt; 0
            [length] =&gt; 65535
            [flags] =&gt; 0
            [content_type] =&gt; 0
        )
    [1] =&gt; mysql_xdevapi\FieldMetadata Object
        (
            [type] =&gt; 1
            [type_name] =&gt; SINT
            [name] =&gt; age
            [original_name] =&gt; age
            [table] =&gt; names
            [original_table] =&gt; names
            [schema] =&gt; addressbook
            [catalog] =&gt; def
            [collation] =&gt; 0
            [fractional_digits] =&gt; 0
            [length] =&gt; 11
            [flags] =&gt; 0
            [content_type] =&gt; 0
        )
)</pre>
</div>
   </div>
  </div>
 </div>


</div><?php manual_footer($setup); ?>