📄 group__g__connect.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): Connecting to Database</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>Connecting to Database</h1><hr><a name="_details"></a><h2>Detailed Description</h2>Connecting to a database server is done with one call to <a class="el" href="group__g__connect.html#gdb6e2cdf759587dd81c2fda7c5f44338" title="Create a physical connection to an Oracle database server.">OCI_ConnectionCreate()</a>.<p><a class="el" href="group__g__connect.html#gc3fe655e96074adb119908be4650a4c9" title="Close a physical connection to an Oracle database server.">OCI_ConnectionFree()</a> closes the established connection.<p>Connection properties are accessible through a set of functions<p><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(<span class="keywordtype">void</span>){ <a class="code" href="struct_o_c_i___connection.html" title="Oracle physical connection.">OCI_Connection</a> *cn; <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); printf(<span class="stringliteral">"Server major version : %i\n"</span>, <a class="code" href="group__g__connect.html#g2d7618d8eae73643dd75067a40e656a1" title="Return the major version number of the connected database server.">OCI_GetServerMajorVersion</a>(cn)); printf(<span class="stringliteral">"Server minor version : %i\n"</span>, <a class="code" href="group__g__connect.html#g8f48a3c755751e5df415160913c6c7ee" title="Return the minor version number of the connected database server.">OCI_GetServerMinorVersion</a>(cn)); printf(<span class="stringliteral">"Server revision version : %i\n\n"</span>, <a class="code" href="group__g__connect.html#ge4c3b37f1c9fc79d36220aa9c96d4415" title="Return the revision version number of the connected database server.">OCI_GetServerRevisionVersion</a>(cn)); printf(<span class="stringliteral">"Connection version : %i\n\n"</span>, <a class="code" href="group__g__connect.html#g6f61147801fce4b69edb4981ba4ea1b7" title="Return the highest Oracle version is supported by the connection.">OCI_GetVersionConnection</a>(cn)); <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___connection.html">OCI_Connection</a> *OCI_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__g__connect.html#gdb6e2cdf759587dd81c2fda7c5f44338">OCI_ConnectionCreate</a> (const mtext *db, const mtext *user, const mtext *pwd, unsigned int mode)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Create a physical connection to an Oracle database server. <a href="#gdb6e2cdf759587dd81c2fda7c5f44338"></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__connect.html#gc3fe655e96074adb119908be4650a4c9">OCI_ConnectionFree</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Close a physical connection to an Oracle database server. <a href="#gc3fe655e96074adb119908be4650a4c9"></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__connect.html#gaa13dc7489eeebcc6bd2a54fb88248b7">OCI_IsConnected</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE is the given connection is still connected otherwise FALSE. <a href="#gaa13dc7489eeebcc6bd2a54fb88248b7"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">OCI_EXPORT void *OCI_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__g__connect.html#g79621217bc8fb84907c453258a2a33e1">OCI_GetUserData</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the previously pointer to user data associated with the connection. <a href="#g79621217bc8fb84907c453258a2a33e1"></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__connect.html#geed5fe2da7af18c69585fbec9f63c951">OCI_SetUserData</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con, void *data)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Associate to the given connection a pointer to user data. <a href="#geed5fe2da7af18c69585fbec9f63c951"></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__connect.html#ga2c0ebf89f90f9780145a102e3ea6dfc">OCI_GetDatabase</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the connected database/service name. <a href="#ga2c0ebf89f90f9780145a102e3ea6dfc"></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__connect.html#g36f22edbe20d0cc1bbbb311dc58552e8">OCI_GetUserName</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current logged user name. <a href="#g36f22edbe20d0cc1bbbb311dc58552e8"></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__connect.html#g5386c85fc9c03a2f824aac04adb1317f">OCI_GetPassword</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current logged user password. <a href="#g5386c85fc9c03a2f824aac04adb1317f"></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__connect.html#g9442dd482fee879033bea7a3a00ace24">OCI_SetPassword</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con, const mtext *password)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Change the password of the logged user. <a href="#g9442dd482fee879033bea7a3a00ace24"></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__connect.html#g92919dbcb84121aa97b6cfbd48dfd832">OCI_GetSessionMode</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current session mode. <a href="#g92919dbcb84121aa97b6cfbd48dfd832"></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__connect.html#ged47a25a1f96fd630f176fe702ac443a">OCI_GetVersionServer</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the connected database server version. <a href="#ged47a25a1f96fd630f176fe702ac443a"></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__connect.html#g2d7618d8eae73643dd75067a40e656a1">OCI_GetServerMajorVersion</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the major version number of the connected database server. <a href="#g2d7618d8eae73643dd75067a40e656a1"></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__connect.html#g8f48a3c755751e5df415160913c6c7ee">OCI_GetServerMinorVersion</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the minor version number of the connected database server. <a href="#g8f48a3c755751e5df415160913c6c7ee"></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__connect.html#ge4c3b37f1c9fc79d36220aa9c96d4415">OCI_GetServerRevisionVersion</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the revision version number of the connected database server. <a href="#ge4c3b37f1c9fc79d36220aa9c96d4415"></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__connect.html#g7fbe35082dadb74584cab6a89183aa19">OCI_SetDefaultFormatDate</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con, const mtext *format)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Set the date format for implicit string / date conversions. <a href="#g7fbe35082dadb74584cab6a89183aa19"></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__connect.html#g88036a98ff02dfadb2ad50800c38684c">OCI_GetDefaultFormatDate</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current date format for implicit string / date conversions. <a href="#g88036a98ff02dfadb2ad50800c38684c"></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__connect.html#g591e0e1e49c7ff06e50f5ab17edf3dbf">OCI_SetDefaultFormatNumeric</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con, const mtext *format)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Set the numeric format for implicit string / numeric conversions. <a href="#g591e0e1e49c7ff06e50f5ab17edf3dbf"></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__connect.html#g57c1be56edaf86588dfb7a1245bf5908">OCI_GetDefaultFormatNumeric</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current numeric format for implicit string / numeric conversions. <a href="#g57c1be56edaf86588dfb7a1245bf5908"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">OCI_EXPORT <a class="el" href="struct_o_c_i___transaction.html">OCI_Transaction</a> *OCI_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__g__connect.html#g033d19889ff80f7d5ff16285392ed696">OCI_GetTransaction</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current transaction of the connection. <a href="#g033d19889ff80f7d5ff16285392ed696"></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__connect.html#gcd5bcb0f0894ffcafcb6dfee5e850f5a">OCI_SetTransaction</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con, <a class="el" href="struct_o_c_i___transaction.html">OCI_Transaction</a> *trans)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current transaction attached to the connection. <a href="#gcd5bcb0f0894ffcafcb6dfee5e850f5a"></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__connect.html#g6f61147801fce4b69edb4981ba4ea1b7">OCI_GetVersionConnection</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return the highest Oracle version is supported by the connection. <a href="#g6f61147801fce4b69edb4981ba4ea1b7"></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__connect.html#ga2be0c485c4937039d1fec437420dcf9">OCI_SetTrace</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con, unsigned int trace, const mtext *value)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Set tracing information to the session of the given connection. <a href="#ga2be0c485c4937039d1fec437420dcf9"></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__connect.html#g6dade2d9faa0050ecbb6685a6970f562">OCI_GetTrace</a> (<a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a> *con, unsigned int trace)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current trace for the trace type from the given connection. <a href="#g6dade2d9faa0050ecbb6685a6970f562"></a><br></td></tr></table><hr><h2>Function Documentation</h2><a class="anchor" name="gdb6e2cdf759587dd81c2fda7c5f44338"></a><!-- doxytag: member="ocilib.h::OCI_ConnectionCreate" ref="gdb6e2cdf759587dd81c2fda7c5f44338" args="(const mtext *db, const mtext *user, const mtext *pwd, unsigned int mode)" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">OCI_EXPORT <a class="el" href="struct_o_c_i___connection.html">OCI_Connection</a>* OCI_API OCI_ConnectionCreate </td> <td>(</td> <td class="paramtype">const mtext * </td> <td class="paramname"> <em>db</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const mtext * </td> <td class="paramname"> <em>user</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const mtext * </td> <td class="paramname"> <em>pwd</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned int </td> <td class="paramname"> <em>mode</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>Create a physical connection to an Oracle database server. <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>db</em> </td><td>- Oracle Service Name </td></tr> <tr><td valign="top"></td><td valign="top"><em>user</em> </td><td>- Oracle User name </td></tr> <tr><td valign="top"></td><td valign="top"><em>pwd</em> </td><td>- Oracle User password </td></tr> <tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>- Session mode</td></tr> </table></dl>Possible values for parameter mode :<ul><li>OCI_SESSION_DEFAULT</li><li>OCI_SESSION_SYSDBA</li><li>OCI_SESSION_SYSOPER</li></ul><p><dl class="note" compact><dt><b>Note:</b></dt><dd>External credentials are supported by supplying a null value for the 'user' and 'pwd' parameters<p>On success, a transaction is automatically created and started</dd></dl><dl class="return" compact><dt><b>Returns:</b></dt><dd>Connection handle on success or NULL on failure </dd></dl><p>Definition at line <a class="el" href="connection_8c-source.html#l00546">546</a> of file <a class="el" href="connection_8c-source.html">connection.c</a>.</p><p>References <a class="el" href="group__g__connect.html#gc3fe655e96074adb119908be4650a4c9">OCI_ConnectionFree()</a>.</p></div></div><p><a class="anchor" name="gc3fe655e96074adb119908be4650a4c9"></a><!-- doxytag: member="ocilib.h::OCI_ConnectionFree" ref="gc3fe655e96074adb119908be4650a4c9" args="(OCI_Connection *con)" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">OCI_EXPORT boolean OCI_API OCI_ConnectionFree </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> <td> ) </td> <td width="100%"></td> </tr> </table></div><div class="memdoc"><p>Close a physical connection to an Oracle database server. <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> </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="connection_8c-source.html#l00578">578</a> of file <a class="el" href="connection_8c-source.html">connection.c</a>.</p><p>References <a class="el" href="ocilib__types_8h-source.html#l00132">OCI_Error::con</a>, and <a class="el" href="ocilib__types_8h-source.html#l00264">OCI_Connection::pool</a>.</p><p>Referenced by <a class="el" href="group__g__connect.html#gdb6e2cdf759587dd81c2fda7c5f44338">OCI_ConnectionCreate()</a>, and <a class="el" href="group__g__connpool.html#g774ce156deb3477c83237a633b6538f6">OCI_ConnPoolGetConnection()</a>.</p></div></div><p><a class="anchor" name="ga2c0ebf89f90f9780145a102e3ea6dfc"></a><!-- doxytag: member="ocilib.h::OCI_GetDatabase" ref="ga2c0ebf89f90f9780145a102e3ea6dfc" args="(OCI_Connection *con)" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">OCI_EXPORT const mtext* OCI_API OCI_GetDatabase </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> <td> ) </td> <td width="100%"></td> </tr> </table></div><div class="memdoc"><p>Return the name of the connected database/service name. <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> </table></dl><p>Definition at line <a class="el" href="connection_8c-source.html#l00741">741</a> of file <a class="el" href="connection_8c-source.html">connection.c</a>.</p><p>References <a class="el" href="ocilib__types_8h-source.html#l00256">OCI_Connection::db</a>.</p></div></div><p><a class="anchor" name="g88036a98ff02dfadb2ad50800c38684c"></a><!-- doxytag: member="ocilib.h::OCI_GetDefaultFormatDate" ref="g88036a98ff02dfadb2ad50800c38684c" args="(OCI_Connection *con)" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">OCI_EXPORT const mtext* OCI_API OCI_GetDefaultFormatDate </td> <td>(</td>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -