📄 group__g__desc.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"><title>OCILIB (C Driver for Oracle): Describing Schema Metadatas and Objects</title><link href="doxygen.css" rel="stylesheet" type="text/css"><link href="tabs.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.5.4 --><div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul></div><h1>Describing Schema Metadatas and Objects</h1><hr><a name="_details"></a><h2>Detailed Description</h2><dl class="user" compact><dt><b>Example</b></dt><dd><div class="fragment"><pre class="fragment"> <span class="preprocessor">#include "ocilib.h"</span><span class="keywordtype">int</span> main(){ <a class="code" href="struct_o_c_i___connection.html" title="Oracle physical connection.">OCI_Connection</a> *cn; <a class="code" href="struct_o_c_i___schema.html" title="Schema metadata handle.">OCI_Schema</a> *tbl; <span class="keywordtype">int</span> i,n; <span class="keywordflow">if</span> (!<a class="code" href="group__g__init.html#gcdb642d75f7c8478e083634144bc813c" title="Initializes the library.">OCI_Initialize</a>(NULL, NULL, OCI_ENV_DEFAULT)) <span class="keywordflow">return</span> EXIT_FAILURE; cn = <a class="code" href="group__g__connect.html#gdb6e2cdf759587dd81c2fda7c5f44338" title="Create a physical connection to an Oracle database server.">OCI_ConnectionCreate</a>(<span class="stringliteral">"db"</span>, <span class="stringliteral">"usr"</span>, <span class="stringliteral">"pwd"</span>, OCI_SESSION_DEFAULT); tbl = <a class="code" href="group__g__desc.html#gba23217d4a9477dc1c373b7392bd15de" title="Retrieve the available schema information.">OCI_SchemaGet</a>(cn, <span class="stringliteral">"products"</span>, OCI_SCHEMA_TABLE); <span class="keywordflow">if</span> (tbl != NULL) { printf (<span class="stringliteral">"Column Name Type Length Prec. Scale Null ?\n"</span>); printf (<span class="stringliteral">"---------------------------- ------------------------------\n"</span>); n = <a class="code" href="group__g__desc.html#g2f1776350725fc6286333141428d35cd" title="Retruns the number of columns of a table/view/object.">OCI_SchemaGetColumnCount</a>(tbl); <span class="keywordflow">for</span>(i = 1; i <= n; i++) { <a class="code" href="struct_o_c_i___column.html" title="Oracle SQL Column and Type member representation.">OCI_Column</a> *col = <a class="code" href="group__g__desc.html#g54d9514129172773ed87017f9603febf" title="Return the column object handle at the given index in the table.">OCI_SchemaGetColumn</a>(tbl, i); printf(<span class="stringliteral">"%-20s%-10s%-8i%-8i%-8i%-s\n"</span>, OCI_GetColumnName(col), OCI_GetColumnSQLType(col), OCI_GetColumnSize(col), OCI_GetColumnPrecision(col), OCI_GetColumnScale(col), OCI_GetColumnNullable(col) == TRUE ? <span class="stringliteral">"Y"</span> : <span class="stringliteral">"N"</span>); } } <a class="code" href="group__g__init.html#g639706aa8e9689c7ebffc018fac6d3ae" title="Clean up all resources allocated by the library.">OCI_Cleanup</a>(); <span class="keywordflow">return</span> EXIT_SUCCESS;}</pre></div> </dd></dl><p><table border="0" cellpadding="0" cellspacing="0"><tr><td></td></tr><tr><td colspan="2"><br><h2>Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">OCI_EXPORT <a class="el" href="struct_o_c_i___schema.html">OCI_Schema</a> *OCI_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__g__desc.html#gba23217d4a9477dc1c373b7392bd15de">OCI_SchemaGet</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con, const mtext *name, unsigned int type)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the available schema information. <a href="#gba23217d4a9477dc1c373b7392bd15de"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">OCI_EXPORT unsigned int OCI_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__g__desc.html#g32df7f2059febe1f4654b1b56900b30d">OCI_SchemaGetType</a> (<a class="el" href="struct_o_c_i___schema.html">OCI_Schema</a> *schema)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the type schema object. <a href="#g32df7f2059febe1f4654b1b56900b30d"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">OCI_EXPORT boolean OCI_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__g__desc.html#g61364dbec3c2f18c49b66906daa24849">OCI_SchemaFree</a> (<a class="el" href="struct_o_c_i___schema.html">OCI_Schema</a> *schema)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Free a schema object. <a href="#g61364dbec3c2f18c49b66906daa24849"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">OCI_EXPORT unsigned int OCI_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__g__desc.html#g2f1776350725fc6286333141428d35cd">OCI_SchemaGetColumnCount</a> (<a class="el" href="struct_o_c_i___schema.html">OCI_Schema</a> *schema)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Retruns the number of columns of a table/view/object. <a href="#g2f1776350725fc6286333141428d35cd"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">OCI_EXPORT <a class="el" href="struct_o_c_i___column.html">OCI_Column</a> *OCI_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__g__desc.html#g54d9514129172773ed87017f9603febf">OCI_SchemaGetColumn</a> (<a class="el" href="struct_o_c_i___schema.html">OCI_Schema</a> *schema, unsigned int index)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the column object handle at the given index in the table. <a href="#g54d9514129172773ed87017f9603febf"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">OCI_EXPORT const mtext *OCI_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__g__desc.html#g4c1d0b674727add24a40df582a590520">OCI_SchemaGetName</a> (<a class="el" href="struct_o_c_i___schema.html">OCI_Schema</a> *schema)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name described by the schema object. <a href="#g4c1d0b674727add24a40df582a590520"></a><br></td></tr></table><hr><h2>Function Documentation</h2><a class="anchor" name="g61364dbec3c2f18c49b66906daa24849"></a><!-- doxytag: member="ocilib.h::OCI_SchemaFree" ref="g61364dbec3c2f18c49b66906daa24849" args="(OCI_Schema *schema)" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">OCI_EXPORT boolean OCI_API OCI_SchemaFree </td> <td>(</td> <td class="paramtype"><a class="el" href="struct_o_c_i___schema.html">OCI_Schema</a> * </td> <td class="paramname"> <em>schema</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table></div><div class="memdoc"><p>Free a schema object. <p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>schema</em> </td><td>- Schema object handle</td></tr> </table></dl><dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE on success otherwise FALSE </dd></dl><p>Definition at line <a class="el" href="schema_8c-source.html#l00306">306</a> of file <a class="el" href="schema_8c-source.html">schema.c</a>.</p><p>References <a class="el" href="ocilib__types_8h-source.html#l00553">OCI_Schema::con</a>, and <a class="el" href="ocilib__types_8h-source.html#l00230">OCI_Connection::sobjs</a>.</p><p>Referenced by <a class="el" href="group__g__desc.html#gba23217d4a9477dc1c373b7392bd15de">OCI_SchemaGet()</a>.</p></div></div><p><a class="anchor" name="gba23217d4a9477dc1c373b7392bd15de"></a><!-- doxytag: member="ocilib.h::OCI_SchemaGet" ref="gba23217d4a9477dc1c373b7392bd15de" args="(OCI_Connection *con, const mtext *name, unsigned int type)" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">OCI_EXPORT <a class="el" href="struct_o_c_i___schema.html">OCI_Schema</a>* OCI_API OCI_SchemaGet </td> <td>(</td> <td class="paramtype"><a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> * </td> <td class="paramname"> <em>con</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const mtext * </td> <td class="paramname"> <em>name</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned int </td> <td class="paramname"> <em>type</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table></div><div class="memdoc"><p>Retrieve the available schema information. <p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>con</em> </td><td>- Connection handle </td></tr> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>- Table/view name to query for </td></tr> <tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>- Type of object</td></tr> </table></dl><dl class="note" compact><dt><b>Note:</b></dt><dd>Possible values for parameter type are :</dd></dl><ul><li>OCI_SCHEMA_UNKNOWN</li><li>OCI_SCHEMA_TABLE</li><li>OCI_SCHEMA_VIEW</li><li>OCI_SCHEMA_TYPE</li></ul>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -