Skip to content

Document JDBC connection properties#640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonathanpeppers merged 5 commits into from
Aug 18, 2026
+72 −18
Merged

Document JDBC connection properties #640

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
192119f
Document JDBC connection properties
jonathanpeppers Aug 17, 2026
910fc74
Correct JDBC property constant references
jonathanpeppers Aug 18, 2026
dabfc95
Use managed JDBC type references
jonathanpeppers Aug 18, 2026
ba1565d
Clarify JDBC type map updates
jonathanpeppers Aug 18, 2026
f7e5efd
Reference managed database metadata
jonathanpeppers Aug 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 72 additions & 18 deletions docs/xml/Java.Sql/IConnection.xml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,8 +111,13 @@
<Docs>
<summary>Returns a <c>boolean</c> indicating whether or not this connection is in
the <c>auto-commit</c> operating mode.</summary>
<value>To be added.</value>
<value>The current state of this <c>Connection</c> object's auto-commit mode.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/sql/Connection#getAutoCommit()" title="Reference documentation">Android reference for <code>java.sql.Connection.getAutoCommit()</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
Expand DownExpand Up@@ -145,8 +150,13 @@
</ReturnValue>
<Docs>
<summary>Gets this <c>Connection</c> object's current catalog name.</summary>
<value>To be added.</value>
<value>The current catalog name, or <c>null</c> if there is none.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/sql/Connection#getCatalog()" title="Reference documentation">Android reference for <code>java.sql.Connection.getCatalog()</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
Expand DownExpand Up@@ -222,8 +232,13 @@
</ReturnValue>
<Docs>
<summary>Returns a <see cref="T:Java.Util.Properties" /> object containing all client info properties.</summary>
<value>To be added.</value>
<value>A <c>Properties</c> object containing the name and current value of each client info property supported by the driver.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/sql/Connection#getClientInfo()" title="Reference documentation">Android reference for <code>java.sql.Connection.getClientInfo()</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 9" />
Expand DownExpand Up@@ -904,8 +919,13 @@
<Docs>
<summary>Returns the holdability property that any <c>ResultSet</c> produced by
this instance will have.</summary>
<value>To be added.</value>
<value>The holdability, one of <see cref="F:Java.Sql.IResultSet.HoldCursorsOverCommit" /> or <see cref="F:Java.Sql.IResultSet.CloseCursorsAtCommit" />.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/sql/Connection#getHoldability()" title="Reference documentation">Android reference for <code>java.sql.Connection.getHoldability()</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
Expand DownExpand Up@@ -937,8 +957,13 @@
<Docs>
<summary>Returns a <c>boolean</c> indicating whether or not this connection is in
the <c>closed</c> state.</summary>
<value>To be added.</value>
<value><c>true</c> if this <c>Connection</c> object is closed; <c>false</c> if it is still open.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/sql/Connection#isClosed()" title="Reference documentation">Android reference for <code>java.sql.Connection.isClosed()</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
Expand DownExpand Up@@ -1023,8 +1048,13 @@
</ReturnValue>
<Docs>
<summary>Gets the metadata about the database referenced by this connection.</summary>
<value>To be added.</value>
<value>An <see cref="T:Java.Sql.IDatabaseMetaData" /> object for this <c>Connection</c> object.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/sql/Connection#getMetaData()" title="Reference documentation">Android reference for <code>java.sql.Connection.getMetaData()</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
Expand DownExpand Up@@ -1743,8 +1773,13 @@
<Docs>
<summary>Returns a <c>boolean</c> indicating whether or not this connection is
currently in the <c>read-only</c> state.</summary>
<value>To be added.</value>
<value><c>true</c> if this <c>Connection</c> object is read-only; otherwise, <c>false</c>.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/sql/Connection#isReadOnly()" title="Reference documentation">Android reference for <code>java.sql.Connection.isReadOnly()</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
Expand DownExpand Up@@ -2099,20 +2134,23 @@
</ReturnValue>
<Docs>
<summary>Returns the transaction isolation level for this connection.</summary>
<value>To be added.</value>
<value>When getting this property, the current transaction isolation level: <see cref="F:Java.Sql.IConnection.TransactionReadUncommitted" />, <see cref="F:Java.Sql.IConnection.TransactionReadCommitted" />, <see cref="F:Java.Sql.IConnection.TransactionRepeatableRead" />, <see cref="F:Java.Sql.IConnection.TransactionSerializable" />, or <see cref="F:Java.Sql.IConnection.TransactionNone" />. When setting this property, one of the same values except <see cref="F:Java.Sql.IConnection.TransactionNone" />.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/sql/Connection#getTransactionIsolation()" title="Reference documentation">Android reference for <code>java.sql.Connection.getTransactionIsolation()</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
<exception cref="T:Java.Sql.SQLException">if there is a problem accessing the database.</exception>
<altmember cref="F:Java.Sql.Connection.TransactionNone" />
<altmember cref="F:Java.Sql.Connection.TransactionReadCommitted" />
<altmember cref="F:Java.Sql.Connection.TransactionReadUncommitted" />
<altmember cref="F:Java.Sql.Connection.TransactionRepeatableRead" />
<altmember cref="F:Java.Sql.Connection.TransactionSerializable" />
<exception cref="T:Java.Sql.SQLException">if there is a problem with the database or if the value of
<c>level</c> is not one of the expected constant values.
</exception>
<altmember cref="F:Java.Sql.IConnection.TransactionNone" />
<altmember cref="F:Java.Sql.IConnection.TransactionReadCommitted" />
<altmember cref="F:Java.Sql.IConnection.TransactionReadUncommitted" />
<altmember cref="F:Java.Sql.IConnection.TransactionRepeatableRead" />
<altmember cref="F:Java.Sql.IConnection.TransactionSerializable" />
<exception cref="T:Java.Sql.SQLException">if there is a problem with the database or if this property is set to a value other than <see cref="F:Java.Sql.IConnection.TransactionReadUncommitted" />, <see cref="F:Java.Sql.IConnection.TransactionReadCommitted" />, <see cref="F:Java.Sql.IConnection.TransactionRepeatableRead" />, or <see cref="F:Java.Sql.IConnection.TransactionSerializable" />.</exception>
</Docs>
</Member>
<Member MemberName="TransactionNone">
Expand DownExpand Up@@ -2358,8 +2396,19 @@
</ReturnValue>
<Docs>
<summary>Returns the type mapping associated with this <c>Connection</c> object.</summary>
<value>To be added.</value>
<value>The current <see cref="T:System.Collections.Generic.IDictionary`2">IDictionary&lt;string, Java.Lang.Class&gt;</see> type map.</value>
<remarks>
<para>After modifying the dictionary returned by this property, assign it back to this property because a JDBC driver may keep an internal copy of the type map.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/sql/Connection#getTypeMap()" title="Reference documentation">Android reference for <code>java.sql.Connection.getTypeMap()</code>.</a>
</format>
</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/sql/Connection#setTypeMap(java.util.Map&lt;java.lang.String,java.lang.Class&lt;?&gt;&gt;)" title="Reference documentation">Android reference for <code>java.sql.Connection.setTypeMap(java.util.Map)</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
Expand DownExpand Up@@ -2389,8 +2438,13 @@
<Docs>
<summary>Gets the first instance of any <c>SQLWarning</c> objects that may have
been created in the use of this connection.</summary>
<value>To be added.</value>
<value>The first <c>SQLWarning</c> object or <c>null</c> if there are none.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/sql/Connection#getWarnings()" title="Reference documentation">Android reference for <code>java.sql.Connection.getWarnings()</code>.</a>
</format>
</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
Expand Down