/en/api-reference/jdbc-api/ Recent content in JDBC API on Vertica 26.1.x Hugo -- gohugo.io /en/api-reference/jdbc-api/overview-tree/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/overview-tree/ <ul> <li>java.lang.Object</li> </ul> <p>com.vertica.jdbc.common.BaseConnectionFactory</p> <p>com.vertica.jdbc.common.AbstractDataSource (implements javax.sql.ConnectionPoolDataSource, javax.sql.DataSource)</p> <p>com.vertica.jdbc.hybrid.HybridAbstractDataSource</p> <p>com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a> (implements javax.sql.DataSource)</p> <ul> <li>com.vertica.jdbc.common.AbstractDriver (implements java.sql.Driver)</li> </ul> <p>com.vertica.jdbc.hybrid.HybridAbstractDriver</p> <p>com.vertica.jdbc.<a href="com/vertica/jdbc/Driver.md">Driver</a></p> <ul> <li>com.vertica.dsi.dataengine.utilities.DSIMonthSpan (implements java.lang.Cloneable)</li> </ul> <p>com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaYearMonthInterval.md">VerticaYearMonthInterval</a> (implements java.lang.Cloneable)</p> <ul> <li>com.vertica.dsi.dataengine.utilities.DSITimeSpan (implements java.lang.Cloneable)</li> </ul> <p>com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a> (implements java.lang.Cloneable)</p> <ul> <li> <p>com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaCopyStream.md">VerticaCopyStream</a></p> </li> <li> <p>com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaTypes.md">VerticaTypes</a></p> </li> <li> <p>com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> </li> </ul> <h2 id="interface-hierarchy">Interface Hierarchy</h2> <ul> <li>java.lang.AutoCloseable</li> </ul> <p>java.sql.Connection (also extends java.sql.Wrapper)</p> <p>com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaConnection.md">VerticaConnection</a></p> <p>com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a></p> <ul> <li>java.sql.Statement (also extends java.sql.Wrapper)</li> </ul> <p>java.sql.PreparedStatement</p> <p>com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaPreparedStatement.md">VerticaPreparedStatement</a></p> <ul> <li> <p>com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaStatement.md">VerticaStatement</a></p> </li> <li> <p>com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDatabaseErrorInfo.md">VerticaDatabaseErrorInfo</a></p> </li> <li> <p>com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VerticaRoutableExecutor.md">VerticaRoutableExecutor</a></p> </li> <li> <p>com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VGet.md">VGet</a></p> </li> <li> <p>java.sql.Wrapper</p> </li> </ul> <p>java.sql.Connection (also extends java.lang.AutoCloseable)</p> <p>com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaConnection.md">VerticaConnection</a></p> <p>com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a></p> <ul> <li>java.sql.Statement (also extends java.lang.AutoCloseable)</li> </ul> <p>java.sql.PreparedStatement</p> <p>com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaPreparedStatement.md">VerticaPreparedStatement</a></p> <ul> <li>com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaStatement.md">VerticaStatement</a></li> </ul> <h2 id="enum-hierarchy">Enum Hierarchy</h2> <ul> <li>java.lang.Object</li> </ul> <p>java.lang.Enum (implements java.lang.Comparable, java.io.Serializable)</p> <p>com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VGet.SortOrder.md">VGet.SortOrder</a></p> /en/api-reference/jdbc-api/allclasses-noframe/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/allclasses-noframe/ <ul> <li> <p><a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> </li> <li> <p><a href="com/vertica/jdbc/Driver.md">Driver</a></p> </li> <li> <p><a href="com/vertica/jdbc/VerticaConnection.md">VerticaConnection</a></p> </li> <li> <p><a href="com/vertica/jdbc/VerticaCopyStream.md">VerticaCopyStream</a></p> </li> <li> <p><a href="com/vertica/jdbc/VerticaDatabaseErrorInfo.md">VerticaDatabaseErrorInfo</a></p> </li> <li> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> </li> <li> <p><a href="com/vertica/jdbc/VerticaPreparedStatement.md">VerticaPreparedStatement</a></p> </li> <li> <p><a href="com/vertica/jdbc/kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a></p> </li> <li> <p><a href="com/vertica/jdbc/kv/VerticaRoutableExecutor.md">VerticaRoutableExecutor</a></p> </li> <li> <p><a href="com/vertica/jdbc/VerticaStatement.md">VerticaStatement</a></p> </li> <li> <p><a href="com/vertica/jdbc/VerticaTypes.md">VerticaTypes</a></p> </li> <li> <p><a href="com/vertica/jdbc/VerticaYearMonthInterval.md">VerticaYearMonthInterval</a></p> </li> <li> <p><a href="com/vertica/jdbc/kv/VGet.md">VGet</a></p> </li> <li> <p><a href="com/vertica/jdbc/kv/VGet.SortOrder.md">VGet.SortOrder</a></p> </li> <li> <p><a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> </li> </ul> /en/api-reference/jdbc-api/com/vertica/jdbc/package-summary/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/com/vertica/jdbc/package-summary/ <ul> <li> <table> <thead> <tr> <th>Interface</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>VerticaConnection</td> <td>This interface defines the public Vertica Analytic Database extensions to java.sql.Connection.</td> </tr> <tr> <td>VerticaDatabaseErrorInfo</td> <td>Exposes additional information about errors that occur on the database server.</td> </tr> <tr> <td>VerticaPreparedStatement</td> <td>This interface defines the public Vertica Analytic Database extensions to java.sql.Statement.</td> </tr> <tr> <td>VerticaStatement</td> <td>This interface defines the public Vertica Analytic Database extensions to java.sql.Statement.</td> </tr> </tbody> </table> </li> <li> <table> <thead> <tr> <th>Class</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>DataSource</td> <td></td> </tr> <tr> <td>Driver</td> <td></td> </tr> <tr> <td>VerticaCopyStream</td> <td>A bulk loading utility that sends COPY FROM LOCAL STDIN data from a JDBC client to the Vertica database.</td> </tr> <tr> <td>VerticaDayTimeInterval</td> <td>The JDBC representation of the Vertica INTERVAL DAY TO SECOND type.</td> </tr> <tr> <td>VerticaTypes</td> <td>This class defines Vertica identifiers for data types Vertica supports but which are not represented in java.sql.types.</td> </tr> <tr> <td>VerticaYearMonthInterval</td> <td>The JDBC representation of the Vertica INTERVAL YEAR TO MONTH type.</td> </tr> </tbody> </table> </li> </ul> /en/api-reference/jdbc-api/com/vertica/jdbc/package-tree/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/com/vertica/jdbc/package-tree/ <h2 id="class-hierarchy">Class Hierarchy</h2> <ul> <li>java.lang.Object</li> </ul> <p>com.vertica.jdbc.common.BaseConnectionFactory</p> <p>com.vertica.jdbc.common.AbstractDataSource (implements javax.sql.ConnectionPoolDataSource, javax.sql.DataSource)</p> <p>com.vertica.jdbc.hybrid.HybridAbstractDataSource</p> <p>com.vertica.jdbc.<a href="DataSource.md">DataSource</a> (implements javax.sql.DataSource)</p> <ul> <li>com.vertica.jdbc.common.AbstractDriver (implements java.sql.Driver)</li> </ul> <p>com.vertica.jdbc.hybrid.HybridAbstractDriver</p> <p>com.vertica.jdbc.<a href="Driver.md">Driver</a></p> <ul> <li>com.vertica.dsi.dataengine.utilities.DSIMonthSpan (implements java.lang.Cloneable)</li> </ul> <p>com.vertica.jdbc.<a href="VerticaYearMonthInterval.md">VerticaYearMonthInterval</a> (implements java.lang.Cloneable)</p> <ul> <li>com.vertica.dsi.dataengine.utilities.DSITimeSpan (implements java.lang.Cloneable)</li> </ul> <p>com.vertica.jdbc.<a href="VerticaDayTimeInterval.md">VerticaDayTimeInterval</a> (implements java.lang.Cloneable)</p> <ul> <li> <p>com.vertica.jdbc.<a href="VerticaCopyStream.md">VerticaCopyStream</a></p> </li> <li> <p>com.vertica.jdbc.<a href="VerticaTypes.md">VerticaTypes</a></p> </li> </ul> <h2 id="interface-hierarchy">Interface Hierarchy</h2> <ul> <li>java.lang.AutoCloseable</li> </ul> <p>java.sql.Connection (also extends java.sql.Wrapper)</p> <p>com.vertica.jdbc.<a href="VerticaConnection.md">VerticaConnection</a></p> <ul> <li>java.sql.Statement (also extends java.sql.Wrapper)</li> </ul> <p>java.sql.PreparedStatement</p> <p>com.vertica.jdbc.<a href="VerticaPreparedStatement.md">VerticaPreparedStatement</a></p> <ul> <li> <p>com.vertica.jdbc.<a href="VerticaStatement.md">VerticaStatement</a></p> </li> <li> <p>com.vertica.jdbc.<a href="VerticaDatabaseErrorInfo.md">VerticaDatabaseErrorInfo</a></p> </li> <li> <p>java.sql.Wrapper</p> </li> </ul> <p>java.sql.Connection (also extends java.lang.AutoCloseable)</p> <p>com.vertica.jdbc.<a href="VerticaConnection.md">VerticaConnection</a></p> <ul> <li>java.sql.Statement (also extends java.lang.AutoCloseable)</li> </ul> <p>java.sql.PreparedStatement</p> <p>com.vertica.jdbc.<a href="VerticaPreparedStatement.md">VerticaPreparedStatement</a></p> <ul> <li>com.vertica.jdbc.<a href="VerticaStatement.md">VerticaStatement</a></li> </ul> /en/api-reference/jdbc-api/com/vertica/jdbc/kv/package-summary/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/com/vertica/jdbc/kv/package-summary/ <ul> <li> <table> <thead> <tr> <th>Interface</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>VerticaRoutableConnection</td> <td>Deprecated This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>VerticaRoutableExecutor</td> <td>Deprecated This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>VGet</td> <td>Deprecated This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> </tbody> </table> </li> <li> <table> <thead> <tr> <th>Class</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>VHash</td> <td>Deprecated This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> </tbody> </table> </li> <li> <table> <thead> <tr> <th>Enum</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>VGet.SortOrder</td> <td>Describes the ordering of result data.</td> </tr> </tbody> </table> </li> </ul> /en/api-reference/jdbc-api/com/vertica/jdbc/kv/package-tree/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/com/vertica/jdbc/kv/package-tree/ <h2 id="class-hierarchy">Class Hierarchy</h2> <ul> <li>java.lang.Object</li> </ul> <p>com.vertica.jdbc.kv.<a href="VHash.md">VHash</a></p> <h2 id="interface-hierarchy">Interface Hierarchy</h2> <ul> <li>java.lang.AutoCloseable</li> </ul> <p>java.sql.Connection (also extends java.sql.Wrapper)</p> <p>com.vertica.jdbc.<a href="../VerticaConnection.md">VerticaConnection</a></p> <p>com.vertica.jdbc.kv.<a href="VerticaRoutableConnection.md">VerticaRoutableConnection</a></p> <ul> <li> <p>com.vertica.jdbc.kv.<a href="VerticaRoutableExecutor.md">VerticaRoutableExecutor</a></p> </li> <li> <p>com.vertica.jdbc.kv.<a href="VGet.md">VGet</a></p> </li> <li> <p>java.sql.Wrapper</p> </li> </ul> <p>java.sql.Connection (also extends java.lang.AutoCloseable)</p> <p>com.vertica.jdbc.<a href="../VerticaConnection.md">VerticaConnection</a></p> <p>com.vertica.jdbc.kv.<a href="VerticaRoutableConnection.md">VerticaRoutableConnection</a></p> <h2 id="enum-hierarchy">Enum Hierarchy</h2> <ul> <li>java.lang.Object</li> </ul> <p>java.lang.Enum (implements java.lang.Comparable, java.io.Serializable)</p> <p>com.vertica.jdbc.kv.<a href="VGet.SortOrder.md">VGet.SortOrder</a></p> /en/api-reference/jdbc-api/com/vertica/jdbc/datasource/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/com/vertica/jdbc/datasource/ <ul> <li> <p>java.lang.Object</p> </li> <li> <p>com.vertica.jdbc.common.BaseConnectionFactory</p> </li> <li> <p>com.vertica.jdbc.common.AbstractDataSource</p> </li> <li> <p>com.vertica.jdbc.hybrid.HybridAbstractDataSource</p> </li> <li> <p>com.vertica.jdbc.DataSource</p> </li> <li> <p>All Implemented Interfaces: java.sql.Wrapper, javax.sql.CommonDataSource, javax.sql.ConnectionPoolDataSource, javax.sql.DataSource</p> </li> </ul> <pre tabindex="0"><code>public class DataSource extends com.vertica.jdbc.hybrid.HybridAbstractDataSource implements javax.sql.DataSource </code></pre><h3 id="field-summary">Field Summary</h3> <h3 id="fields-inherited-from-classcomverticajdbccommonbaseconnectionfactory">Fields inherited from class com.vertica.jdbc.common.BaseConnectionFactory</h3> <p>CONNECTION_LOCALE_KEY, s_Messages, URL_SEPARATOR</p> <h3 id="constructor-summary">Constructor Summary</h3> <table> <thead> <tr> <th>Constructor and Description</th> </tr> </thead> <tbody> <tr> <td>DataSource()</td> </tr> </tbody> </table> <h3 id="method-summary">Method Summary</h3> <table> <thead> <tr> <th>Modifier and Type</th> <th>Method and Description</th> </tr> </thead> <tbody> <tr> <td>boolean</td> <td>areBatchInsertsDirect() Get if batch inserts are direct for the data source.</td> </tr> <tr> <td>java.lang.String</td> <td>getBackupServerNode() Get list of backup server nodes.</td> </tr> <tr> <td>boolean</td> <td>getBinaryTransfer() Get whether or not connection uses binary transfer</td> </tr> <tr> <td>java.lang.String</td> <td>getConnSettings() Returns the session initialization sql that will run when a connection is established.</td> </tr> <tr> <td>java.lang.String</td> <td>getDatabase() Get the database for the data source.</td> </tr> <tr> <td>boolean</td> <td>getDisableCopyLocal() Gets the value of the connection setting that determines whether file-based COPY LOCAL operations are disabled.</td> </tr> <tr> <td>boolean</td> <td>getEnableRoutableQueries() Deprecated. This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>boolean</td> <td>getFailOnMultiNodePlans() Deprecated. This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>java.lang.String</td> <td>getHost() Get the host for the data source.</td> </tr> <tr> <td>java.lang.String</td> <td>getHostNameVerifier() Get if TLS Mode for the data source.</td> </tr> <tr> <td>java.lang.String</td> <td>getJAASConfigName() Gets the name of the JAAS configuration entry that will the driver will use when performing GSS authentication.</td> </tr> <tr> <td>java.lang.String</td> <td>getKerberosHostName() Gets the host name portion of the kerberos service principal that identifies the Vertica server.</td> </tr> <tr> <td>java.lang.String</td> <td>getKerberosServiceName() Gets the service name portion of the kerberos service principal that identifies the Vertica server.</td> </tr> <tr> <td>java.lang.String</td> <td>getKeyStorePassword() Gets the password for the keystore file.</td> </tr> <tr> <td>java.lang.String</td> <td>getKeyStorePath() Gets the path to the keystore file, or &quot;&quot; if not specified.</td> </tr> <tr> <td>java.lang.String</td> <td>getLocale() Get the locale for the data source.</td> </tr> <tr> <td>java.lang.String</td> <td>getLogDirectory() Gets the directory used to store log files</td> </tr> <tr> <td>int</td> <td>getLoginNetworkTimeout() Get the LoginNetworkTimeout for the data source.</td> </tr> <tr> <td>int</td> <td>getLoginNodeTimeout() Get the LoginNodeTimeout for the data source.</td> </tr> <tr> <td>int</td> <td>getLoginTimeout() Get the login timeout for the data source.</td> </tr> <tr> <td>com.vertica.support.LogLevel</td> <td>getLogLevel() Gets current level of logging</td> </tr> <tr> <td>java.lang.String</td> <td>getLogNameSpace() Gets package that logging is restricted to</td> </tr> <tr> <td>boolean</td> <td>getMarsEnabled()</td> </tr> <tr> <td>int</td> <td>getMaxPooledConnections() Deprecated. This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>int</td> <td>getMaxPooledConnectionsPerNode() Deprecated. This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>int</td> <td>getMaxPooledConnectionUses() Deprecated. This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>int</td> <td>getMetadataCacheLifetime() Deprecated. This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>int</td> <td>getNetworkTimeout() Gets the current network timeout value.</td> </tr> <tr> <td>int</td> <td>getNodeDownWaitTime() Deprecated. This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>java.lang.String</td> <td>getOAuthAccessToken() Gets the access token used for OAuth authentication.</td> </tr> <tr> <td>java.lang.String</td> <td>getOAuthClientId() Gets the client ID used for OAuth authentication.</td> </tr> <tr> <td>java.lang.String</td> <td>getOAuthClientSecret() Gets the client secret used for OAuth authentication.</td> </tr> <tr> <td>java.lang.String</td> <td>getOAuthDiscoveryUrl() Gets the discovery url used to fetch the OAuth token endpoint.</td> </tr> <tr> <td>java.lang.String</td> <td>getOAuthRefreshToken() Gets the refresh token used for OAuth authentication.</td> </tr> <tr> <td>java.lang.String</td> <td>getOAuthScope() Gets the scope of the access request used for OAuth token refresh.</td> </tr> <tr> <td>java.lang.String</td> <td>getOAuthTokenUrl() Gets the token url used for OAuth authentication.</td> </tr> <tr> <td>java.util.logging.Logger</td> <td>getParentLogger() Get parent Logger of all the Loggers used by this data source.</td> </tr> <tr> <td>short</td> <td>getPort() Get the port for the data source.</td> </tr> <tr> <td>int</td> <td>getPortInt() Get the port for the data source as an inteter.</td> </tr> <tr> <td>java.lang.String</td> <td>getPreferredAddressFamily() Gets the preferred address family type to be used when resolving hostnames.</td> </tr> <tr> <td>long</td> <td>getResultBufferSize() Get the maximum size of the client side ResultSet cache for the data source.</td> </tr> <tr> <td>java.lang.String</td> <td>getSearchPath() Get the schema search path for this data source.</td> </tr> <tr> <td>java.lang.String</td> <td>getSessionLabel() Get the session label for the data source.</td> </tr> <tr> <td>java.lang.String</td> <td>getSessionTimezone() Get the session timezone for the data source.</td> </tr> <tr> <td>java.lang.String</td> <td>getSocketFactoryName() Get the custom socket factory name for the data source.</td> </tr> <tr> <td>java.lang.String</td> <td>getSSLSocketFactoryName() Get the custom SSL socket factory name for the data source.</td> </tr> <tr> <td>boolean</td> <td>getStreamingBatchInsert() Gets the value of the connection setting that determines whether the streaming or non-streaming batch insert model is used.</td> </tr> <tr> <td>java.lang.String</td> <td>getTLSMode() Get TLS Mode for the data source.</td> </tr> <tr> <td>int</td> <td>getTransactionIsolation() Get the transaction isolation for the data source.</td> </tr> <tr> <td>java.lang.String</td> <td>getTrustStorePassword() Gets the password for the truststore file.</td> </tr> <tr> <td>java.lang.String</td> <td>getTrustStorePath() Gets the path to the truststore file, or &quot;&quot; if not specified.</td> </tr> <tr> <td>java.lang.String</td> <td>getUser() Get current user</td> </tr> <tr> <td>boolean</td> <td>isAutoCommitOnByDefault() Get if autocommit is enabled by default for the data source.</td> </tr> <tr> <td>boolean</td> <td>isReadOnly() Get if the data source is read only.</td> </tr> <tr> <td>boolean</td> <td>isSslEnabled() Deprecated. getTLSMode method provide finer information.</td> </tr> <tr> <td>boolean</td> <td>isWrapperFor(java.lang.Class iface)</td> </tr> <tr> <td>void</td> <td>setAutoCommitOnByDefault(boolean isAutoCommit) Set if autocommit is enabled by default for the data source.</td> </tr> <tr> <td>void</td> <td>setBackupServerNode(java.lang.String backupServerNode) Sets the list of backup server nodes for this data source.</td> </tr> <tr> <td>void</td> <td>setBatchInsertsDirect(boolean isDirect) Deprecated. This method has been deprecated. WOS and moveout operations are no longer supported. All connections use direct batch insert.</td> </tr> <tr> <td>void</td> <td>setBinaryTransfer(boolean enabled) Sets the flag that indicates whether or not to use binary transfer</td> </tr> <tr> <td>void</td> <td>setConnectionLoadBalance(boolean useConnectionLoadBalance) Sets the flag that indicates whether or not to use native load balancing.</td> </tr> <tr> <td>void</td> <td>setConnSettings(java.lang.String sql) ConnSettings are sql statements that the driver will execute when a connection is made.</td> </tr> <tr> <td>void</td> <td>setDatabase(java.lang.String database) Set the database for the data source.</td> </tr> <tr> <td>void</td> <td>setDisableCopyLocal(boolean disabled) Sets the value of the connection setting that determines whether file-based COPY LOCAL operations are disabled.</td> </tr> <tr> <td>void</td> <td>setEnableRoutableQueries(boolean enabled) Deprecated. This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>void</td> <td>setFailOnMultiNodePlans(boolean enabled) Deprecated. This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>void</td> <td>setHost(java.lang.String host) Set the host for the data source.</td> </tr> <tr> <td>void</td> <td>setHostNameVerifier(java.lang.String hvn) Set user defined HostnameVerifier.</td> </tr> <tr> <td>void</td> <td>setJAASConfigName(java.lang.String name) Sets the name of the JAAS configuration entry that will be used when performing GSS-Kerberos authentication.</td> </tr> <tr> <td>void</td> <td>setKerberosHostName(java.lang.String name) Sets the host name portion of the kerberos service principal that identifies the Vertica server.</td> </tr> <tr> <td>void</td> <td>setKerberosServiceName(java.lang.String name) Sets the service name portion of the kerberos service principal that identifies the Vertica server.</td> </tr> <tr> <td>void</td> <td>setKeyStorePassword(java.lang.String paramString) Sets the password protecting the keystore file.</td> </tr> <tr> <td>void</td> <td>setKeyStorePath(java.lang.String paramString) Sets the path to a keystore file (typically in .jks format) to be used for TLS connections.</td> </tr> <tr> <td>void</td> <td>setLocale(java.lang.String locale) Set the locale for the data source.</td> </tr> <tr> <td>void</td> <td>setLogDirectory(java.lang.String paramString) Sets the directory used to store log files.</td> </tr> <tr> <td>void</td> <td>setLoginNetworkTimeout(int timeout) Set the loginNetworkTimeout for the data source.</td> </tr> <tr> <td>void</td> <td>setLoginNodeTimeout(int timeout) Set the loginNodeTimeout for the data source.</td> </tr> <tr> <td>void</td> <td>setLoginTimeout(int loginTimeout) Set the login timeout for the data source.</td> </tr> <tr> <td>void</td> <td>setLogLevel(java.lang.String paramString) Sets the log level Valid values: OFF (no logging) INFO WARNING TRACE ERROR DEBUG (most verbose) An invalid value will set log level to OFF</td> </tr> <tr> <td>void</td> <td>setLogNameSpace(java.lang.String value) Sets the package that logging is restricted to.</td> </tr> <tr> <td>void</td> <td>setMarsEnabled(boolean value)</td> </tr> <tr> <td>void</td> <td>setMaxPooledConnections(int max) Deprecated. This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>void</td> <td>setMaxPooledConnectionsPerNode(int max) Deprecated. This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>void</td> <td>setMaxPooledConnectionUses(int uses) Deprecated. This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>void</td> <td>setMetadataCacheLifetime(int lifetime) Deprecated. This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>void</td> <td>setNetworkTimeout(int milliseconds) Sets the network timeout.</td> </tr> <tr> <td>void</td> <td>setNodeDownWaitTime(int waitTime) Deprecated. This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>void</td> <td>setOAuthAccessToken(java.lang.String accessToken) Sets the access token used for OAuth authentication.</td> </tr> <tr> <td>void</td> <td>setOAuthClientId(java.lang.String clientId) Sets the client ID used for OAuth authentication.</td> </tr> <tr> <td>void</td> <td>setOAuthClientSecret(java.lang.String clientSecret) Sets the client secret used for OAuth authentication.</td> </tr> <tr> <td>void</td> <td>setOAuthDiscoveryUrl(java.lang.String discoveryUrl) Sets the discovery url used to fetch the OAuth token endpoint.</td> </tr> <tr> <td>void</td> <td>setOAuthRefreshToken(java.lang.String refreshToken) Sets the refresh token used for OAuth authentication.</td> </tr> <tr> <td>void</td> <td>setOAuthScope(java.lang.String scope) Sets the scope of the access request used for OAuth token refresh.</td> </tr> <tr> <td>void</td> <td>setOAuthTokenUrl(java.lang.String tokenUrl) Sets the token url used for OAuth authentication.</td> </tr> <tr> <td>void</td> <td>setPort(int port) Set the port for the data source as an integer.</td> </tr> <tr> <td>void</td> <td>setPort(short port) Set the port for the data source.</td> </tr> <tr> <td>void</td> <td>setPreferredAddressFamily(java.lang.String value) Sets the address family type to prefer when the driver resolves hostnames.</td> </tr> <tr> <td>void</td> <td>setReadOnly(boolean readOnly) Set if the data source is read only.</td> </tr> <tr> <td>void</td> <td>setResultBufferSize(long size) Set the maximum amount of data to cache in bytes when streaming ResultSet data.</td> </tr> <tr> <td>void</td> <td>setSearchPath(java.lang.String searchPath) Sets the schema search path for this data source.</td> </tr> <tr> <td>void</td> <td>setSessionLabel(java.lang.String label) Set the session label for the data source.</td> </tr> <tr> <td>void</td> <td>setSessionTimezone(java.lang.String tz)</td> </tr> <tr> <td>void</td> <td>setSocketFactoryName(java.lang.String socketFactoryName) Set the custom socket factory name for the data source.</td> </tr> <tr> <td>void</td> <td>setSslEnabled(boolean isSslEnabled) Deprecated. setTLSMode provides finer grained control over the TLS connection process</td> </tr> <tr> <td>void</td> <td>setSSLSocketFactoryName(java.lang.String sslSocketFactoryName) Set the custom SSL socket factory name for the data source.</td> </tr> <tr> <td>void</td> <td>setStreamingBatchInsert(boolean enabled) Sets the value of the connection setting that determines whether the streaming or non-streaming batch insert model is used.</td> </tr> <tr> <td>void</td> <td>setThreePartNaming(boolean useThreePartNaming) Set three part naming for the data source.</td> </tr> <tr> <td>void</td> <td>setTLSMode(java.lang.String mode) Set TLS Mode for data source.</td> </tr> <tr> <td>void</td> <td>setTrustStorePassword(java.lang.String paramString) Sets the password protecting the truststore file.</td> </tr> <tr> <td>void</td> <td>setTrustStorePath(java.lang.String paramString) Sets the path to a truststore file (typically in .jks format) to be used for TLS connections.</td> </tr> <tr> <td>void</td> <td>setUser(java.lang.String user) Sets the current user</td> </tr> <tr> <td>T</td> <td>unwrap(java.lang.Class iface)</td> </tr> <tr> <td>boolean</td> <td>useConnectionLoadBalance() Get whether or not connection load balancing is in use.</td> </tr> <tr> <td>boolean</td> <td>useThreePartNaming() Get if three-part naming is used for the data source.</td> </tr> </tbody> </table> <h3 id="methods-inherited-from-classcomverticajdbccommonabstractdatasource">Methods inherited from class com.vertica.jdbc.common.AbstractDataSource</h3> <p>getConnection, getConnection, getCustomProperty, getLogWriter, getPassword, getPooledConnection, getPooledConnection, getUserID, initialize, removeCustomProperty, setCustomProperty, setLogWriter, setPassword, setURL, setUserID</p> <h3 id="methods-inherited-from-classjavalangobject">Methods inherited from class java.lang.Object</h3> <p>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</p> <h3 id="methods-inherited-from-interfacejavaxsqldatasource">Methods inherited from interface javax.sql.DataSource</h3> <p>getConnection, getConnection</p> <h3 id="methods-inherited-from-interfacejavaxsqlcommondatasource">Methods inherited from interface javax.sql.CommonDataSource</h3> <p>getLogWriter, setLogWriter</p> <h3 id="constructor-detail">Constructor Detail</h3> <h4 id="datasource">DataSource</h4> <pre tabindex="0"><code>public DataSource() </code></pre><h3 id="method-detail">Method Detail</h3> <h4 id="arebatchinsertsdirect">areBatchInsertsDirect</h4> <pre tabindex="0"><code>public boolean areBatchInsertsDirect() </code></pre><p>Get if batch inserts are direct for the data source. <strong>Returns</strong> true if batch inserts go directly into the ROS for the data source.</p> <h4 id="getdatabase">getDatabase</h4> <pre tabindex="0"><code>public java.lang.String getDatabase() </code></pre><p>Get the database for the data source. <strong>Returns</strong> The database for the data source.</p> <h4 id="gethost">getHost</h4> <pre tabindex="0"><code>public java.lang.String getHost() </code></pre><p>Get the host for the data source. <strong>Returns</strong> The host for the data source.</p> <h4 id="getlocale">getLocale</h4> <pre tabindex="0"><code>public java.lang.String getLocale() </code></pre><p>Get the locale for the data source. <strong>Returns</strong> The locale for the data source.</p> <h4 id="getsessiontimezone">getSessionTimezone</h4> <pre tabindex="0"><code>public java.lang.String getSessionTimezone() </code></pre><p>Get the session timezone for the data source. <strong>Returns</strong> A string representing the timezone</p> <h4 id="getlogintimeout">getLoginTimeout</h4> <pre tabindex="0"><code>public int getLoginTimeout() </code></pre><p>Get the login timeout for the data source.</p> <p><strong>Specified by</strong> getLoginTimeout in interface javax.sql.CommonDataSource <strong>Overrides</strong> getLoginTimeout in class com.vertica.jdbc.common.AbstractDataSource <strong>Returns</strong> The login timeout for the data source.</p> <h4 id="getloginnetworktimeout">getLoginNetworkTimeout</h4> <pre tabindex="0"><code>public int getLoginNetworkTimeout() </code></pre><p>Get the LoginNetworkTimeout for the data source. <strong>Returns</strong> The LoginNetworkTimeout for the data source.</p> <h4 id="getloginnodetimeout">getLoginNodeTimeout</h4> <pre tabindex="0"><code>public int getLoginNodeTimeout() </code></pre><p>Get the LoginNodeTimeout for the data source. <strong>Returns</strong> The LoginNodeTimeout for the data source.</p> <h4 id="getsocketfactoryname">getSocketFactoryName</h4> <pre tabindex="0"><code>public java.lang.String getSocketFactoryName() </code></pre><p>Get the custom socket factory name for the data source. <strong>Returns</strong> The custom socket factory name for the data source.</p> <h4 id="getsslsocketfactoryname">getSSLSocketFactoryName</h4> <pre tabindex="0"><code>public java.lang.String getSSLSocketFactoryName() </code></pre><p>Get the custom SSL socket factory name for the data source. <strong>Returns</strong> The custom socket factory name for the data source.</p> <h4 id="getresultbuffersize">getResultBufferSize</h4> <pre tabindex="0"><code>public long getResultBufferSize() </code></pre><p>Get the maximum size of the client side ResultSet cache for the data source. <strong>Returns</strong> The maximum size of the client side ResultSet cache for the data source.</p> <h4 id="getport">getPort</h4> <pre tabindex="0"><code>public short getPort() </code></pre><p>Get the port for the data source. <strong>Returns</strong> The port for the data source.</p> <h4 id="getportint">getPortInt</h4> <pre tabindex="0"><code>public int getPortInt() </code></pre><p>Get the port for the data source as an inteter. <strong>Returns</strong> The port for the data source.</p> <h4 id="isreadonly">isReadOnly</h4> <pre tabindex="0"><code>public boolean isReadOnly() </code></pre><p>Get if the data source is read only. <strong>Returns</strong> true if the data source is read only.</p> <h4 id="getsearchpath">getSearchPath</h4> <pre tabindex="0"><code>public java.lang.String getSearchPath() </code></pre><p>Get the schema search path for this data source. <strong>Returns</strong> A comma separated list of schemas.</p> <h4 id="getsessionlabel">getSessionLabel</h4> <pre tabindex="0"><code>public java.lang.String getSessionLabel() </code></pre><p>Get the session label for the data source. <strong>Returns</strong> The session label for the data source.</p> <h4 id="gettransactionisolation">getTransactionIsolation</h4> <pre tabindex="0"><code>public int getTransactionIsolation() </code></pre><p>Get the transaction isolation for the data source. <strong>Returns</strong> The transaction isolation for the data source.</p> <h4 id="isautocommitonbydefault">isAutoCommitOnByDefault</h4> <pre tabindex="0"><code>public boolean isAutoCommitOnByDefault() </code></pre><p>Get if autocommit is enabled by default for the data source. <strong>Returns</strong> true if autocommit is enabled by default for the data source.</p> <h4 id="issslenabled">isSslEnabled</h4> <pre tabindex="0"><code>public boolean isSslEnabled() </code></pre><p>Deprecated. <a href="DataSource.md#getTLSMode">getTLSMode</a> method provide finer information. Get if SSL is enabled for the data source. <strong>Returns</strong> true if SSL is enabled (&gt;= Require in TLSMode) for the data source.</p> <h4 id="gettlsmode">getTLSMode</h4> <pre tabindex="0"><code>public java.lang.String getTLSMode() </code></pre><p>Get TLS Mode for the data source. <strong>Returns</strong> Currently support Disable, Require, Verify-ca and Verify-full.</p> <h4 id="gethostnameverifier">getHostNameVerifier</h4> <pre tabindex="0"><code>public java.lang.String getHostNameVerifier() </code></pre><p>Get if TLS Mode for the data source. <strong>Returns</strong> Hostname verifer in use, default value is com.vertica.security.VerticaHostnameVerifier.</p> <h4 id="useconnectionloadbalance">useConnectionLoadBalance</h4> <pre tabindex="0"><code>public boolean useConnectionLoadBalance() </code></pre><p>Get whether or not connection load balancing is in use. <strong>Returns</strong> true if connection load balancing is enabled for the data source.</p> <h4 id="getbackupservernode">getBackupServerNode</h4> <pre tabindex="0"><code>public java.lang.String getBackupServerNode() </code></pre><p>Get list of backup server nodes. <strong>Returns</strong> Comma-separated list of backup server nodes for this data source.</p> <h4 id="getuser">getUser</h4> <pre tabindex="0"><code>public java.lang.String getUser() </code></pre><p>Get current user <strong>Returns</strong> the current user</p> <h4 id="getparentlogger">getParentLogger</h4> <pre tabindex="0"><code>public java.util.logging.Logger getParentLogger() throws java.sql.SQLFeatureNotSupportedException </code></pre><p>Get parent Logger of all the Loggers used by this data source.</p> <p><strong>Specified by</strong> getParentLogger in interface javax.sql.CommonDataSource <strong>Returns</strong> the Logger farthest from the root Logger that is still an ancestor of all of the Loggers used by this data source Throws: java.sql.SQLFeatureNotSupportedException</p> <h4 id="setautocommitonbydefault">setAutoCommitOnByDefault</h4> <pre tabindex="0"><code>public void setAutoCommitOnByDefault(boolean isAutoCommit) </code></pre><p>Set if autocommit is enabled by default for the data source. Parameters:isAutoCommit - true if autocommit is enabled by default for the data source.</p> <h4 id="setbatchinsertsdirect">setBatchInsertsDirect</h4> <pre tabindex="0"><code>@Deprecated public void setBatchInsertsDirect(boolean isDirect) </code></pre><p>Deprecated. This method has been deprecated. WOS and moveout operations are no longer supported. All connections use direct batch insert. Set if batch inserts should go directly to the ROS for the data source. Parameters:isDirect - ignored</p> <h4 id="setdatabase">setDatabase</h4> <pre tabindex="0"><code>public void setDatabase(java.lang.String database) </code></pre><p>Set the database for the data source. Parameters:database - The database for the data source.</p> <h4 id="sethost">setHost</h4> <pre tabindex="0"><code>public void setHost(java.lang.String host) </code></pre><p>Set the host for the data source. Parameters:host - The host for the data source.</p> <h4 id="setlocale">setLocale</h4> <pre tabindex="0"><code>public void setLocale(java.lang.String locale) </code></pre><p>Set the locale for the data source. Parameters:locale - The locale for the data source.</p> <h4 id="setsessiontimezone">setSessionTimezone</h4> <pre tabindex="0"><code>public void setSessionTimezone(java.lang.String tz) </code></pre><h4 id="setlogintimeout">setLoginTimeout</h4> <pre tabindex="0"><code>public void setLoginTimeout(int loginTimeout) </code></pre><p>Set the login timeout for the data source.</p> <p><strong>Specified by</strong> setLoginTimeout in interface javax.sql.CommonDataSource <strong>Overrides</strong> setLoginTimeout in class com.vertica.jdbc.common.AbstractDataSource Parameters:loginTimeout - The login timeout for the data source.</p> <h4 id="setloginnetworktimeout">setLoginNetworkTimeout</h4> <pre tabindex="0"><code>public void setLoginNetworkTimeout(int timeout) </code></pre><p>Set the loginNetworkTimeout for the data source. Parameters:timeout - The loginNetworkTimeout for the data source.</p> <h4 id="setloginnodetimeout">setLoginNodeTimeout</h4> <pre tabindex="0"><code>public void setLoginNodeTimeout(int timeout) </code></pre><p>Set the loginNodeTimeout for the data source. Parameters:timeout - The loginNodeTimeout for the data source.</p> <h4 id="setsslsocketfactoryname">setSSLSocketFactoryName</h4> <pre tabindex="0"><code>public void setSSLSocketFactoryName(java.lang.String sslSocketFactoryName) </code></pre><p>Set the custom SSL socket factory name for the data source. If set, this must be the name of a class that extends javax.net.ssl.SSLSocketFactory with a zero-argument constructor that is available on the class path.</p> <p>Typically the SSLSocketFactory will act as a wrapper for a raw socket, performing SSL/TLS encryption prior to forwarding the bytes to the underlying socket.</p> <p>If also using a cusom socket factory (via <a href="DataSource.md#setSocketFactoryName">setSocketFactoryName(String socketFactoryName)</a>), then that factory will create the raw socket and this factory will be passed that raw socket for I/O. Parameters:sslSocketFactoryName - The custom SSL socket factory name for the data source.</p> <h4 id="setsocketfactoryname">setSocketFactoryName</h4> <pre tabindex="0"><code>public void setSocketFactoryName(java.lang.String socketFactoryName) </code></pre><p>Set the custom socket factory name for the data source. If set, this must be the name of a class that extends javax.net.SocketFactory with a zero-argument constructor that is available on the class path. Parameters:socketFactoryName - The custom socket factory name for the data source.</p> <h4 id="setresultbuffersize">setResultBufferSize</h4> <pre tabindex="0"><code>public void setResultBufferSize(long size) </code></pre><p>Set the maximum amount of data to cache in bytes when streaming ResultSet data. Parameters:size - A number of bytes.</p> <h4 id="setport">setPort</h4> <pre tabindex="0"><code>public void setPort(int port) </code></pre><p>Set the port for the data source as an integer. Parameters:port - The port for the data source.</p> <h4 id="setport-1">setPort</h4> <pre tabindex="0"><code>public void setPort(short port) </code></pre><p>Set the port for the data source. Parameters:port - The port for the data source.</p> <h4 id="setreadonly">setReadOnly</h4> <pre tabindex="0"><code>public void setReadOnly(boolean readOnly) </code></pre><p>Set if the data source is read only. Parameters:readOnly - true if the data source is read only.</p> <h4 id="setsessionlabel">setSessionLabel</h4> <pre tabindex="0"><code>public void setSessionLabel(java.lang.String label) </code></pre><p>Set the session label for the data source. Parameters:label - The session label for the data source.</p> <h4 id="setsslenabled">setSslEnabled</h4> <pre tabindex="0"><code>public void setSslEnabled(boolean isSslEnabled) </code></pre><p>Deprecated. <a href="DataSource.md#setTLSMode">setTLSMode</a> provides finer grained control over the TLS connection process Set if SSL is enabled for the data source. Parameters:isSslEnabled - true if SSL is enabled for the data source.</p> <h4 id="settlsmode">setTLSMode</h4> <pre tabindex="0"><code>public void setTLSMode(java.lang.String mode) </code></pre><p>Set TLS Mode for data source. value &gt;= Require will enable TLS/SSL. Parameters:mode - Currently support Disable, Require, Verify-ca and Verify-full.</p> <h4 id="sethostnameverifier">setHostNameVerifier</h4> <pre tabindex="0"><code>public void setHostNameVerifier(java.lang.String hvn) </code></pre><p>Set user defined HostnameVerifier. Only call this function when default hostnameverifier cannot fulfill the requirements. Parameters:hvn - String value of the customized hostnameverifier class location.</p> <h4 id="setthreepartnaming">setThreePartNaming</h4> <pre tabindex="0"><code>public void setThreePartNaming(boolean useThreePartNaming) </code></pre><p>Set three part naming for the data source. When enabled, metadata ResultSets containing a catalog column will report the database name as the catalog, rather than NULL. Parameters:useThreePartNaming - true if three-part naming is enabled for the data source.</p> <h4 id="setsearchpath">setSearchPath</h4> <pre tabindex="0"><code>public void setSearchPath(java.lang.String searchPath) </code></pre><p>Sets the schema search path for this data source. Parameters:searchPath - A comma separated list of schema names.</p> <h4 id="setbackupservernode">setBackupServerNode</h4> <pre tabindex="0"><code>public void setBackupServerNode(java.lang.String backupServerNode) </code></pre><p>Sets the list of backup server nodes for this data source. Parameters:backupServerNode - A comma separated list of vertica servers (host:port[,host:port...])</p> <h4 id="setuser">setUser</h4> <pre tabindex="0"><code>public void setUser(java.lang.String user) </code></pre><p>Sets the current user Parameters:user - current user</p> <h4 id="setconnectionloadbalance">setConnectionLoadBalance</h4> <pre tabindex="0"><code>public void setConnectionLoadBalance(boolean useConnectionLoadBalance) </code></pre><p>Sets the flag that indicates whether or not to use native load balancing. Parameters:useConnectionLoadBalance - true if native load balancing is enabled for the data source.</p> <h4 id="usethreepartnaming">useThreePartNaming</h4> <pre tabindex="0"><code>public boolean useThreePartNaming() </code></pre><p>Get if three-part naming is used for the data source. When enabled, metadata ResultSets containing a catalog column will report the database name as the catalog, rather than NULL. <strong>Returns</strong> true if three-part naming is enabled for the data source.</p> <h4 id="getjaasconfigname">getJAASConfigName</h4> <pre tabindex="0"><code>public java.lang.String getJAASConfigName() </code></pre><p>Gets the name of the JAAS configuration entry that will the driver will use when performing GSS authentication. <strong>Returns</strong> A JAAS configuration name</p> <h4 id="setjaasconfigname">setJAASConfigName</h4> <pre tabindex="0"><code>public void setJAASConfigName(java.lang.String name) </code></pre><p>Sets the name of the JAAS configuration entry that will be used when performing GSS-Kerberos authentication.</p> <p>The driver relies on JAAS to acquire a kerberos ticket-granting-ticket when the database server requests that the client uses GSS authentication. The JAAS configuration identified by this name can be used to customize this process. Parameters:name - The name of a configuration entry in a JAAS configuration file.</p> <h4 id="getkerberosservicename">getKerberosServiceName</h4> <pre tabindex="0"><code>public java.lang.String getKerberosServiceName() </code></pre><p>Gets the service name portion of the kerberos service principal that identifies the Vertica server. <strong>Returns</strong> The Vertica server's kerberos service name.</p> <h4 id="setkerberosservicename">setKerberosServiceName</h4> <pre tabindex="0"><code>public void setKerberosServiceName(java.lang.String name) </code></pre><p>Sets the service name portion of the kerberos service principal that identifies the Vertica server.</p> <p>When the Vertica server requests that the client uses GSS authentication, the client uses this name to request a kerberos service ticket. The value of this property should match the database's KerberosServiceName config parameter. Parameters:name - The Vertica server's kerberos service name.</p> <h4 id="getkerberoshostname">getKerberosHostName</h4> <pre tabindex="0"><code>public java.lang.String getKerberosHostName() </code></pre><p>Gets the host name portion of the kerberos service principal that identifies the Vertica server. <strong>Returns</strong> The Vertica server's kerberos host name.</p> <h4 id="setkerberoshostname">setKerberosHostName</h4> <pre tabindex="0"><code>public void setKerberosHostName(java.lang.String name) </code></pre><p>Sets the host name portion of the kerberos service principal that identifies the Vertica server.</p> <p>When the Vertica server requests that the client uses GSS authentication, the client uses this name to request a kerberos service ticket. The value of this property should match the database's KerberosHostName config parameter. Parameters:name - The Vertica server's kerberos host name.</p> <h4 id="getoauthaccesstoken">getOAuthAccessToken</h4> <pre tabindex="0"><code>public java.lang.String getOAuthAccessToken() </code></pre><p>Gets the access token used for OAuth authentication. <strong>Returns</strong> The client's access token.</p> <h4 id="setoauthaccesstoken">setOAuthAccessToken</h4> <pre tabindex="0"><code>public void setOAuthAccessToken(java.lang.String accessToken) </code></pre><p>Sets the access token used for OAuth authentication. Parameters:accessToken - The client's access token.</p> <h4 id="getoauthrefreshtoken">getOAuthRefreshToken</h4> <pre tabindex="0"><code>public java.lang.String getOAuthRefreshToken() </code></pre><p>Gets the refresh token used for OAuth authentication. <strong>Returns</strong> The client's refresh token.</p> <h4 id="setoauthrefreshtoken">setOAuthRefreshToken</h4> <pre tabindex="0"><code>public void setOAuthRefreshToken(java.lang.String refreshToken) </code></pre><p>Sets the refresh token used for OAuth authentication. Parameters:refreshToken - The client's refresh token.</p> <h4 id="getoauthtokenurl">getOAuthTokenUrl</h4> <pre tabindex="0"><code>public java.lang.String getOAuthTokenUrl() </code></pre><p>Gets the token url used for OAuth authentication. <strong>Returns</strong> The client's token url.</p> <h4 id="setoauthtokenurl">setOAuthTokenUrl</h4> <pre tabindex="0"><code>public void setOAuthTokenUrl(java.lang.String tokenUrl) </code></pre><p>Sets the token url used for OAuth authentication. Parameters:tokenUrl - The client's token url.</p> <h4 id="getoauthclientid">getOAuthClientId</h4> <pre tabindex="0"><code>public java.lang.String getOAuthClientId() </code></pre><p>Gets the client ID used for OAuth authentication. <strong>Returns</strong> The client's ID.</p> <h4 id="setoauthclientid">setOAuthClientId</h4> <pre tabindex="0"><code>public void setOAuthClientId(java.lang.String clientId) </code></pre><p>Sets the client ID used for OAuth authentication. Parameters:clientId - The client's ID.</p> <h4 id="getoauthclientsecret">getOAuthClientSecret</h4> <pre tabindex="0"><code>public java.lang.String getOAuthClientSecret() </code></pre><p>Gets the client secret used for OAuth authentication. <strong>Returns</strong> The client's secret.</p> <h4 id="setoauthclientsecret">setOAuthClientSecret</h4> <pre tabindex="0"><code>public void setOAuthClientSecret(java.lang.String clientSecret) </code></pre><p>Sets the client secret used for OAuth authentication. Parameters:clientSecret - The client's secret.</p> <h4 id="getoauthdiscoveryurl">getOAuthDiscoveryUrl</h4> <pre tabindex="0"><code>public java.lang.String getOAuthDiscoveryUrl() </code></pre><p>Gets the discovery url used to fetch the OAuth token endpoint. <strong>Returns</strong> The client's discovery url.</p> <h4 id="setoauthdiscoveryurl">setOAuthDiscoveryUrl</h4> <pre tabindex="0"><code>public void setOAuthDiscoveryUrl(java.lang.String discoveryUrl) </code></pre><p>Sets the discovery url used to fetch the OAuth token endpoint. Parameters:discoveryUrl - The client's discovery url.</p> <h4 id="getoauthscope">getOAuthScope</h4> <pre tabindex="0"><code>public java.lang.String getOAuthScope() </code></pre><p>Gets the scope of the access request used for OAuth token refresh. <strong>Returns</strong> The scope of the access request used for OAuth token refresh.</p> <h4 id="setoauthscope">setOAuthScope</h4> <pre tabindex="0"><code>public void setOAuthScope(java.lang.String scope) </code></pre><p>Sets the scope of the access request used for OAuth token refresh. Parameters:scope - The scope of the access request used for OAuth token refresh.</p> <h4 id="getstreamingbatchinsert">getStreamingBatchInsert</h4> <pre tabindex="0"><code>public boolean getStreamingBatchInsert() </code></pre><p>Gets the value of the connection setting that determines whether the streaming or non-streaming batch insert model is used. <strong>Returns</strong> true if batches are stored in memory, false if they are sent to the server immediately</p> <h4 id="setstreamingbatchinsert">setStreamingBatchInsert</h4> <pre tabindex="0"><code>public void setStreamingBatchInsert(boolean enabled) </code></pre><p>Sets the value of the connection setting that determines whether the streaming or non-streaming batch insert model is used. Parameters:enabled - True to store batches in memory, false to send them to the server immediately</p> <h4 id="getdisablecopylocal">getDisableCopyLocal</h4> <pre tabindex="0"><code>public boolean getDisableCopyLocal() </code></pre><p>Gets the value of the connection setting that determines whether file-based COPY LOCAL operations are disabled. <strong>Returns</strong> true if file-based COPY LOCAL operations are disabled</p> <h4 id="setdisablecopylocal">setDisableCopyLocal</h4> <pre tabindex="0"><code>public void setDisableCopyLocal(boolean disabled) </code></pre><p>Sets the value of the connection setting that determines whether file-based COPY LOCAL operations are disabled. Parameters:disabled - True to disable file-based COPY LOCAL operations</p> <h4 id="getbinarytransfer">getBinaryTransfer</h4> <pre tabindex="0"><code>public boolean getBinaryTransfer() </code></pre><p>Get whether or not connection uses binary transfer <strong>Returns</strong> true if binary transfer is enabled</p> <h4 id="setbinarytransfer">setBinaryTransfer</h4> <pre tabindex="0"><code>public void setBinaryTransfer(boolean enabled) </code></pre><p>Sets the flag that indicates whether or not to use binary transfer Parameters:enabled - True if binary transfer should be enabled</p> <h4 id="setconnsettings">setConnSettings</h4> <pre tabindex="0"><code>public void setConnSettings(java.lang.String sql) </code></pre><p>ConnSettings are sql statements that the driver will execute when a connection is made. This is typically used to initialize session variables automatically with each connection. Parameters:sql - Semicolon-delimited sql statements that run when a connection is established.</p> <h4 id="getconnsettings">getConnSettings</h4> <pre tabindex="0"><code>public java.lang.String getConnSettings() </code></pre><p>Returns the session initialization sql that will run when a connection is established. If no ConnSettings was specified, &quot;&quot; is returned. <strong>Returns</strong> Semicolon-delimited sql thats that run when a connection is established.</p> <h4 id="getenableroutablequeries">getEnableRoutableQueries</h4> <pre tabindex="0"><code>@Deprecated public boolean getEnableRoutableQueries() </code></pre><p>Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Get if <a href="kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a>s are returned by the data source. <strong>Returns</strong> true if VerticaRoutableConnections are returned.</p> <h4 id="setenableroutablequeries">setEnableRoutableQueries</h4> <pre tabindex="0"><code>@Deprecated public void setEnableRoutableQueries(boolean enabled) </code></pre><p>Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Set if <a href="kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a>s are returned by the data source. Parameters:enabled - true to enable VerticaRoutableConnections</p> <h4 id="getfailonmultinodeplans">getFailOnMultiNodePlans</h4> <pre tabindex="0"><code>@Deprecated public boolean getFailOnMultiNodePlans() </code></pre><p>Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Get if non-local plans are allowed in <a href="kv/VGet.md">VGet</a> operations.</p> <p>Only has an effect on <a href="kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a>s, i.e. when <a href="DataSource.md#getEnableRoutableQueries">getEnableRoutableQueries()</a> returns true. <strong>Returns</strong> true if non-local plans are allowed.</p> <h4 id="setfailonmultinodeplans">setFailOnMultiNodePlans</h4> <pre tabindex="0"><code>@Deprecated public void setFailOnMultiNodePlans(boolean enabled) </code></pre><p>Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Get if non-local plans are allowed in <a href="kv/VGet.md">VGet</a> operations. Only has an effect on <a href="kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a>s, i.e. when <a href="DataSource.md#getEnableRoutableQueries">getEnableRoutableQueries()</a> returns true. Parameters:enabled - true to allow non-local plans, false to disable.</p> <h4 id="setmaxpooledconnectionuses">setMaxPooledConnectionUses</h4> <pre tabindex="0"><code>@Deprecated public void setMaxPooledConnectionUses(int uses) </code></pre><p>Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Set the maximum number times to use a pooled connection before closing it. Only has an effect on <a href="kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a>s, i.e. when <a href="DataSource.md#getEnableRoutableQueries">getEnableRoutableQueries()</a> returns true. Parameters:uses - The maximum number of times to use a pooled connection.</p> <h4 id="getmaxpooledconnectionuses">getMaxPooledConnectionUses</h4> <pre tabindex="0"><code>@Deprecated public int getMaxPooledConnectionUses() </code></pre><p>Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Gets the maximum number times to use a pooled connection before closing it. Only has an effect on <a href="kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a>s, i.e. when <a href="DataSource.md#getEnableRoutableQueries">getEnableRoutableQueries()</a> returns true. <strong>Returns</strong> The maximum number of times to use a pooled connection.</p> <h4 id="setmaxpooledconnections">setMaxPooledConnections</h4> <pre tabindex="0"><code>@Deprecated public void setMaxPooledConnections(int max) </code></pre><p>Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Set the maximum number of pooled connections. Only has an effect on <a href="kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a>s, i.e. when <a href="DataSource.md#getEnableRoutableQueries">getEnableRoutableQueries()</a> returns true. Parameters:max - The maximum number of pooled connections allowed open at a time.</p> <h4 id="getmaxpooledconnections">getMaxPooledConnections</h4> <pre tabindex="0"><code>@Deprecated public int getMaxPooledConnections() </code></pre><p>Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Gets the maximum number of pooled connections. Only has an effect on <a href="kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a>s, i.e. when <a href="DataSource.md#getEnableRoutableQueries">getEnableRoutableQueries()</a> returns true. <strong>Returns</strong> The maximum number pooled connections allowed open at a time.</p> <h4 id="setmaxpooledconnectionspernode">setMaxPooledConnectionsPerNode</h4> <pre tabindex="0"><code>@Deprecated public void setMaxPooledConnectionsPerNode(int max) </code></pre><p>Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Set the maximum number of pooled connections per node. Only has an effect on <a href="kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a>s, i.e. when <a href="DataSource.md#getEnableRoutableQueries">getEnableRoutableQueries()</a> returns true. Parameters:max - The maximum number of pooled connections to a single node allowed open at a time.</p> <h4 id="getmaxpooledconnectionspernode">getMaxPooledConnectionsPerNode</h4> <pre tabindex="0"><code>@Deprecated public int getMaxPooledConnectionsPerNode() </code></pre><p>Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Gets the maximum number of pooled connections per node. Only has an effect on <a href="kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a>s, i.e. when <a href="DataSource.md#getEnableRoutableQueries">getEnableRoutableQueries()</a> returns true. <strong>Returns</strong> The maximum number pooled connections to a single node allowed at a time.</p> <h4 id="getmetadatacachelifetime">getMetadataCacheLifetime</h4> <pre tabindex="0"><code>@Deprecated public int getMetadataCacheLifetime() </code></pre><p>Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Gets the number of seconds to reuse table and projection metadata during <a href="kv/VGet.md">VGet</a> operations. Only has an effect on <a href="kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a>s, i.e. when <a href="DataSource.md#getEnableRoutableQueries">getEnableRoutableQueries()</a> returns true. <strong>Returns</strong> Amount of time in seconds to keep metadata cached.</p> <h4 id="setmetadatacachelifetime">setMetadataCacheLifetime</h4> <pre tabindex="0"><code>@Deprecated public void setMetadataCacheLifetime(int lifetime) </code></pre><p>Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Sets the number of seconds to reuse table and projection metadata during <a href="kv/VGet.md">VGet</a> operations. Only has an effect on <a href="kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a>s, i.e. when <a href="DataSource.md#getEnableRoutableQueries">getEnableRoutableQueries()</a> returns true. Parameters:lifetime - Amount of time in seconds to keep metadata cached.</p> <h4 id="getnodedownwaittime">getNodeDownWaitTime</h4> <pre tabindex="0"><code>@Deprecated public int getNodeDownWaitTime() </code></pre><p>Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Gets the number of seconds to wait before attempting a new connection to a node after detecting a connection failure. Only has an effect on <a href="kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a>s, i.e. when <a href="DataSource.md#getEnableRoutableQueries">getEnableRoutableQueries()</a> returns true. <strong>Returns</strong> Amount of time in seconds to wait before attempting another connection to a node.</p> <h4 id="setnodedownwaittime">setNodeDownWaitTime</h4> <pre tabindex="0"><code>@Deprecated public void setNodeDownWaitTime(int waitTime) </code></pre><p>Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Sets the number of seconds to wait before attempting a new connection to a node after detecting a connection failure. Only has an effect on <a href="kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a>s, i.e. when <a href="DataSource.md#getEnableRoutableQueries">getEnableRoutableQueries()</a> returns true. Parameters:waitTime - Amount of time in seconds to wait before attempting another connection to a node.</p> <h4 id="setpreferredaddressfamily">setPreferredAddressFamily</h4> <pre tabindex="0"><code>public void setPreferredAddressFamily(java.lang.String value) </code></pre><p>Sets the address family type to prefer when the driver resolves hostnames.</p> <p>When set to to &quot;ipv6&quot; the driver will attempt to use IPv6 type AAAA DNS records before IPv4 type A DNS records. When set to &quot;ipv4&quot;, the driver will use IPv4 type A DNS records first.</p> <p>When set to &quot;none&quot; (the default), the driver will take no preference, and instead use the records in the order returned by the JRE. Parameters:value - The preferred address family to use. One of &quot;ipv6&quot;, &quot;ipv4&quot; or &quot;none&quot;</p> <h4 id="getpreferredaddressfamily">getPreferredAddressFamily</h4> <pre tabindex="0"><code>public java.lang.String getPreferredAddressFamily() </code></pre><p>Gets the preferred address family type to be used when resolving hostnames. <strong>Returns</strong> The preferred address family type for the data source.</p> <h4 id="setmarsenabled">setMarsEnabled</h4> <pre tabindex="0"><code>public void setMarsEnabled(boolean value) </code></pre><h4 id="getmarsenabled">getMarsEnabled</h4> <pre tabindex="0"><code>public boolean getMarsEnabled() </code></pre><h4 id="getlognamespace">getLogNameSpace</h4> <pre tabindex="0"><code>public java.lang.String getLogNameSpace() </code></pre><p>Gets package that logging is restricted to <strong>Returns</strong> Namespace for logging</p> <h4 id="setnetworktimeout">setNetworkTimeout</h4> <pre tabindex="0"><code>public void setNetworkTimeout(int milliseconds) </code></pre><p>Sets the network timeout. Valid values:</p> <p>≥= 0</p> <p>Parameters:</p> <p>milliseconds - The network timeout value for the current connection in milliseconds</p> <h4 id="getnetworktimeout">getNetworkTimeout</h4> <pre tabindex="0"><code>public int getNetworkTimeout() </code></pre><p>Gets the current network timeout value. <strong>Returns</strong> Network timeout value in milliseconds</p> <h4 id="setlognamespace">setLogNameSpace</h4> <pre tabindex="0"><code>public void setLogNameSpace(java.lang.String value) </code></pre><p>Sets the package that logging is restricted to. Valid values:</p> <p>com.vertica (all messages generated by the JDBC driver)</p> <ul> <li> <p>com.vertica.jdbc (all messages generated by the top-level JDBC API)</p> </li> <li> <p>com.vertica.jdbc.core (connection and statement settings)</p> </li> <li> <p>com.vertica.jdbc.io (client/server protocol messages)</p> </li> <li> <p>com.vertica.jdbc.util (miscellaneous utilities)</p> </li> <li> <p>com.vertica.jdbc.dataengine (query execution and result set iteration).</p> </li> </ul> <p>Parameters:</p> <p>value - Namespace for logging</p> <h4 id="setloglevel">setLogLevel</h4> <pre tabindex="0"><code>public void setLogLevel(java.lang.String paramString) </code></pre><p>Sets the log level Valid values:</p> <p>OFF (no logging)</p> <ul> <li> <p>INFO</p> </li> <li> <p>WARNING</p> </li> <li> <p>TRACE</p> </li> <li> <p>ERROR</p> </li> <li> <p>DEBUG (most verbose)</p> </li> </ul> <p>An invalid value will set log level to OFF</p> <p><strong>Overrides</strong> setLogLevel in class com.vertica.jdbc.common.AbstractDataSource</p> <p>Parameters:</p> <p>paramString - String indicating the log level. Can also be numbers 1 to 6</p> <h4 id="getloglevel">getLogLevel</h4> <pre tabindex="0"><code>public com.vertica.support.LogLevel getLogLevel() </code></pre><p>Gets current level of logging</p> <p><strong>Overrides</strong> getLogLevel in class com.vertica.jdbc.common.AbstractDataSource <strong>Returns</strong> The level of logging</p> <h4 id="setlogdirectory">setLogDirectory</h4> <pre tabindex="0"><code>public void setLogDirectory(java.lang.String paramString) </code></pre><p>Sets the directory used to store log files. The directory will be created if it does not exist.</p> <p><strong>Overrides</strong> setLogDirectory in class com.vertica.jdbc.common.AbstractDataSource Parameters:paramString - String indicating the directory to log to</p> <h4 id="getlogdirectory">getLogDirectory</h4> <pre tabindex="0"><code>public java.lang.String getLogDirectory() </code></pre><p>Gets the directory used to store log files</p> <p><strong>Overrides</strong> getLogDirectory in class com.vertica.jdbc.common.AbstractDataSource <strong>Returns</strong> The log directory</p> <h4 id="setkeystorepath">setKeyStorePath</h4> <pre tabindex="0"><code>public void setKeyStorePath(java.lang.String paramString) </code></pre><p>Sets the path to a keystore file (typically in .jks format) to be used for TLS connections. If not specified, the JVM-global keystore is used. Parameters:paramString - String with a path to a keystore file</p> <h4 id="getkeystorepath">getKeyStorePath</h4> <pre tabindex="0"><code>public java.lang.String getKeyStorePath() </code></pre><p>Gets the path to the keystore file, or &quot;&quot; if not specified. <strong>Returns</strong> The path to the keystore file</p> <h4 id="settruststorepath">setTrustStorePath</h4> <pre tabindex="0"><code>public void setTrustStorePath(java.lang.String paramString) </code></pre><p>Sets the path to a truststore file (typically in .jks format) to be used for TLS connections. If not specified, the JVM-global truststore is used. Parameters:paramString - String with a path to a truststore file</p> <h4 id="gettruststorepath">getTrustStorePath</h4> <pre tabindex="0"><code>public java.lang.String getTrustStorePath() </code></pre><p>Gets the path to the truststore file, or &quot;&quot; if not specified. <strong>Returns</strong> The path to the truststore file</p> <h4 id="settruststorepassword">setTrustStorePassword</h4> <pre tabindex="0"><code>public void setTrustStorePassword(java.lang.String paramString) </code></pre><p>Sets the password protecting the truststore file. Only used if a custom truststore path is specified. Parameters:paramString - The password to the truststore file</p> <h4 id="gettruststorepassword">getTrustStorePassword</h4> <pre tabindex="0"><code>public java.lang.String getTrustStorePassword() </code></pre><p>Gets the password for the truststore file. <strong>Returns</strong> The password for the truststore file.</p> <h4 id="setkeystorepassword">setKeyStorePassword</h4> <pre tabindex="0"><code>public void setKeyStorePassword(java.lang.String paramString) </code></pre><p>Sets the password protecting the keystore file. Only used if a custom keystore path is specified. If both the keystore and the keys within the keystore are password protected, they must use the same password specified here. Parameters:paramString - The password to the keystore file</p> <h4 id="getkeystorepassword">getKeyStorePassword</h4> <pre tabindex="0"><code>public java.lang.String getKeyStorePassword() </code></pre><p>Gets the password for the keystore file. <strong>Returns</strong> The password for the keystore file.</p> <h4 id="unwrap">unwrap</h4> <pre tabindex="0"><code>public  T unwrap(java.lang.Class iface) throws java.sql.SQLException </code></pre><p><strong>Specified by</strong> unwrap in interface java.sql.Wrapper <strong>Overrides</strong> unwrap in class com.vertica.jdbc.common.AbstractDataSource Throws: java.sql.SQLException</p> <h4 id="iswrapperfor">isWrapperFor</h4> <pre tabindex="0"><code>public boolean isWrapperFor(java.lang.Class iface) throws java.sql.SQLException </code></pre><p><strong>Specified by</strong> isWrapperFor in interface java.sql.Wrapper <strong>Overrides</strong> isWrapperFor in class com.vertica.jdbc.common.AbstractDataSource Throws: java.sql.SQLException</p> /en/api-reference/jdbc-api/deprecated-list/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/deprecated-list/ <ul> <li> <table> <thead> <tr> <th>Interface and Description</th> </tr> </thead> <tbody> <tr> <td>com.vertica.jdbc.kv.VerticaRoutableConnection This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>com.vertica.jdbc.kv.VerticaRoutableExecutor This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>com.vertica.jdbc.kv.VGet This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> </tbody> </table> </li> <li> <table> <thead> <tr> <th>Class and Description</th> </tr> </thead> <tbody> <tr> <td>com.vertica.jdbc.kv.VHash This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> </tbody> </table> </li> <li> <table> <thead> <tr> <th>Field and Description</th> </tr> </thead> <tbody> <tr> <td>com.vertica.jdbc.VerticaDayTimeInterval.INTERVAL_DAY superseded by VerticaTypes.INTERVAL_DAY</td> </tr> <tr> <td>com.vertica.jdbc.VerticaDayTimeInterval.INTERVAL_DAY_TO_HOUR superseded by VerticaTypes.INTERVAL_DAY_TO_HOUR</td> </tr> <tr> <td>com.vertica.jdbc.VerticaDayTimeInterval.INTERVAL_DAY_TO_MINUTE superseded by VerticaTypes.INTERVAL_DAY_TO_MINUTE</td> </tr> <tr> <td>com.vertica.jdbc.VerticaDayTimeInterval.INTERVAL_DAY_TO_SECOND superseded by VerticaTypes.INTERVAL_DAY_TO_SECOND</td> </tr> <tr> <td>com.vertica.jdbc.VerticaDayTimeInterval.INTERVAL_HOUR superseded by VerticaTypes.INTERVAL_HOUR</td> </tr> <tr> <td>com.vertica.jdbc.VerticaDayTimeInterval.INTERVAL_HOUR_TO_MINUTE superseded by VerticaTypes.INTERVAL_HOUR_TO_MINUTE</td> </tr> <tr> <td>com.vertica.jdbc.VerticaDayTimeInterval.INTERVAL_HOUR_TO_SECOND superseded by VerticaTypes.INTERVAL_HOUR_TO_SECOND</td> </tr> <tr> <td>com.vertica.jdbc.VerticaDayTimeInterval.INTERVAL_MINUTE superseded by VerticaTypes.INTERVAL_MINUTE</td> </tr> <tr> <td>com.vertica.jdbc.VerticaDayTimeInterval.INTERVAL_MINUTE_TO_SECOND superseded by VerticaTypes.INTERVAL_MINUTE_TO_SECOND</td> </tr> <tr> <td>com.vertica.jdbc.VerticaYearMonthInterval.INTERVAL_MONTH superseded by VerticaTypes.INTERVAL_MONTH</td> </tr> <tr> <td>com.vertica.jdbc.VerticaDayTimeInterval.INTERVAL_SECOND superseded by VerticaTypes.INTERVAL_SECOND</td> </tr> <tr> <td>com.vertica.jdbc.VerticaYearMonthInterval.INTERVAL_YEAR superseded by VerticaTypes.INTERVAL_YEAR</td> </tr> <tr> <td>com.vertica.jdbc.VerticaYearMonthInterval.INTERVAL_YEAR_TO_MONTH superseded by VerticaTypes.INTERVAL_YEAR_TO_MONTH</td> </tr> </tbody> </table> </li> <li> <table> <thead> <tr> <th>Method and Description</th> </tr> </thead> <tbody> <tr> <td>com.vertica.jdbc.DataSource.getEnableRoutableQueries() This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>com.vertica.jdbc.DataSource.getFailOnMultiNodePlans() This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>com.vertica.jdbc.DataSource.getMaxPooledConnections() This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>com.vertica.jdbc.DataSource.getMaxPooledConnectionsPerNode() This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>com.vertica.jdbc.DataSource.getMaxPooledConnectionUses() This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>com.vertica.jdbc.DataSource.getMetadataCacheLifetime() This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>com.vertica.jdbc.DataSource.getNodeDownWaitTime() This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>com.vertica.jdbc.DataSource.isSslEnabled() getTLSMode method provide finer information.</td> </tr> <tr> <td>com.vertica.jdbc.DataSource.setBatchInsertsDirect(boolean) This method has been deprecated. WOS and moveout operations are no longer supported. All connections use direct batch insert.</td> </tr> <tr> <td>com.vertica.jdbc.DataSource.setEnableRoutableQueries(boolean) This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>com.vertica.jdbc.DataSource.setFailOnMultiNodePlans(boolean) This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>com.vertica.jdbc.DataSource.setMaxPooledConnections(int) This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>com.vertica.jdbc.DataSource.setMaxPooledConnectionsPerNode(int) This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>com.vertica.jdbc.DataSource.setMaxPooledConnectionUses(int) This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>com.vertica.jdbc.DataSource.setMetadataCacheLifetime(int) This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>com.vertica.jdbc.DataSource.setNodeDownWaitTime(int) This feature is likely to stop working in a future release and to be removed as a result.</td> </tr> <tr> <td>com.vertica.jdbc.DataSource.setSslEnabled(boolean) setTLSMode provides finer grained control over the TLS connection process</td> </tr> </tbody> </table> </li> </ul> /en/api-reference/jdbc-api/com/vertica/jdbc/driver/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/com/vertica/jdbc/driver/ <ul> <li> <p>java.lang.Object</p> </li> <li> <p>com.vertica.jdbc.common.BaseConnectionFactory</p> </li> <li> <p>com.vertica.jdbc.common.AbstractDriver</p> </li> <li> <p>com.vertica.jdbc.hybrid.HybridAbstractDriver</p> </li> <li> <p>com.vertica.jdbc.Driver</p> </li> <li> <p>All Implemented Interfaces: java.sql.Driver</p> </li> </ul> <pre tabindex="0"><code>public class Driver extends com.vertica.jdbc.hybrid.HybridAbstractDriver </code></pre><h3 id="field-summary">Field Summary</h3> <table> <thead> <tr> <th>Modifier and Type</th> <th>Field and Description</th> </tr> </thead> <tbody> <tr> <td>static java.lang.String</td> <td>SUBPROTOCOL_NAME The subprotocol is the portion of the connection string that comes after &quot;jdbc:&quot; but before the &quot;://&quot;.</td> </tr> </tbody> </table> <h3 id="fields-inherited-from-classcomverticajdbccommonabstractdriver">Fields inherited from class com.vertica.jdbc.common.AbstractDriver</h3> <p>URL_PROTOCOL</p> <h3 id="fields-inherited-from-classcomverticajdbccommonbaseconnectionfactory">Fields inherited from class com.vertica.jdbc.common.BaseConnectionFactory</h3> <p>CONNECTION_LOCALE_KEY, s_Messages, URL_SEPARATOR</p> <h3 id="constructor-summary">Constructor Summary</h3> <table> <thead> <tr> <th>Constructor and Description</th> </tr> </thead> <tbody> <tr> <td>Driver()</td> </tr> </tbody> </table> <h3 id="method-summary">Method Summary</h3> <table> <thead> <tr> <th>Modifier and Type</th> <th>Method and Description</th> </tr> </thead> <tbody> <tr> <td>java.util.logging.Logger</td> <td>getParentLogger() Get parent Logger of all the Loggers used by this data source.</td> </tr> </tbody> </table> <h3 id="methods-inherited-from-classcomverticajdbchybridhybridabstractdriver">Methods inherited from class com.vertica.jdbc.hybrid.HybridAbstractDriver</h3> <p>initializeDriver</p> <h3 id="methods-inherited-from-classcomverticajdbccommonabstractdriver">Methods inherited from class com.vertica.jdbc.common.AbstractDriver</h3> <p>acceptsURL, connect, getErrorMessageComponentName, getMajorVersion, getMinorVersion, getPropertyInfo, initialize, jdbcCompliant, setErrorMessageComponentName</p> <h3 id="methods-inherited-from-classjavalangobject">Methods inherited from class java.lang.Object</h3> <p>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</p> <h3 id="field-detail">Field Detail</h3> <h4 id="subprotocol_name">SUBPROTOCOL_NAME</h4> <pre tabindex="0"><code>public static final java.lang.String SUBPROTOCOL_NAME </code></pre><p>The subprotocol is the portion of the connection string that comes after &quot;jdbc:&quot; but before the &quot;://&quot;. See Also:Constant Field Values</p> <h3 id="constructor-detail">Constructor Detail</h3> <h4 id="driver">Driver</h4> <pre tabindex="0"><code>public Driver() </code></pre><h3 id="method-detail">Method Detail</h3> <h4 id="getparentlogger">getParentLogger</h4> <pre tabindex="0"><code>public java.util.logging.Logger getParentLogger() throws java.sql.SQLFeatureNotSupportedException </code></pre><p>Get parent Logger of all the Loggers used by this data source. <strong>Returns</strong> the Logger farthest from the root Logger that is still an ancestor of all of the Loggers used by this data source Throws: java.sql.SQLFeatureNotSupportedException</p> /en/api-reference/jdbc-api/index-all/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/index-all/ <p><a href="#_A_">A</a> <a href="#_B_">B</a> <a href="#_C_">C</a> <a href="#_D_">D</a> <a href="#_E_">E</a> <a href="#_F_">F</a> <a href="#_G_">G</a> <a href="#_H_">H</a> <a href="#_I_">I</a> <a href="#_P_">P</a> <a href="#_R_">R</a> <a href="#_S_">S</a> <a href="#_T_">T</a> <a href="#_U_">U</a> <a href="#_V_">V</a> </p> <h2 id="a">A</h2> <p><a href="com/vertica/jdbc/kv/VHash.md#addBoolean">addBoolean(boolean)</a> - Method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>adds hash of boolean value to the chain.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#addBooleanNull">addBooleanNull()</a> - Method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>adds hash of boolean null value to the chain.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#addBytes(byte%5B%5D)">addBytes(byte[])</a> - Method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>adds hash of binary value to the chain.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#addDate">addDate(Date, Calendar)</a> - Method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>adds hash of Date value to the chain.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#addDate">addDate(Date, Calendar)</a> - Method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>adds hash of Date value to the chain.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#addDouble">addDouble(double)</a> - Method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>adds hash of double value to the chain.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#addDoubleNull">addDoubleNull()</a> - Method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>adds hash of double null value to the chain.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#addLong">addLong(long)</a> - Method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>adds hash of long value to the chain.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#addNull">addNull()</a> - Method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>Adds hash of null value to the chain.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#addNumeric">addNumeric(BigDecimal, int)</a> - Method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>adds hash of numeric value to the chain</p> <p><a href="com/vertica/jdbc/kv/VGet.md#addOutputColumn">addOutputColumn(String)</a> - Method in interface com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VGet.md">VGet</a></p> <p>Deprecated.</p> <p>Adds an output column to the ResultSet returned by <a href="com/vertica/jdbc/kv/VGet.md#execute">VGet.execute()</a>.</p> <p><a href="com/vertica/jdbc/kv/VGet.md#addOutputExpression">addOutputExpression(String)</a> - Method in interface com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VGet.md">VGet</a></p> <p>Deprecated.</p> <p>Adds the result of a free-form SQL expression to the ResultSet returned by <a href="com/vertica/jdbc/kv/VGet.md#execute">VGet.execute()</a>.</p> <p><a href="com/vertica/jdbc/kv/VGet.md#addPredicate">addPredicate(String, Object)</a> - Method in interface com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VGet.md">VGet</a></p> <p>Deprecated.</p> <p>Adds or updates a column equality predicate.</p> <p><a href="com/vertica/jdbc/kv/VGet.md#addPredicateExpression">addPredicateExpression(String)</a> - Method in interface com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VGet.md">VGet</a></p> <p>Deprecated.</p> <p>Adds a free-form SQL predicate to filter results.</p> <p><a href="com/vertica/jdbc/kv/VGet.md#addSortColumn">addSortColumn(String, VGet.SortOrder)</a> - Method in interface com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VGet.md">VGet</a></p> <p>Deprecated.</p> <p>Adds the specified column to the sort order of the result.</p> <p><a href="com/vertica/jdbc/VerticaCopyStream.md#addStream">addStream(InputStream)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaCopyStream.md">VerticaCopyStream</a></p> <p>Adds a stream to the list of streams to send in the copy statement.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#addString">addString(String)</a> - Method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>adds hash of String value to the chain.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#addTime">addTime(Time, Calendar)</a> - Method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>adds hash of Time value to the chain.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#addTime">addTime(Date, Calendar)</a> - Method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>adds hash of Time value to the chain.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#addTimestamp">addTimestamp(long)</a> - Method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>adds hash of Timestamp value expressed as milliseconds since Jan 1, 1970 UTC to the chain.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#addTimestamp">addTimestamp(Timestamp, Calendar)</a> - Method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>adds hash of Timestamp value to the chain.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#addTimestamp">addTimestamp(Date, Calendar)</a> - Method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>adds hash of Timestamp value to the chain.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#addUUID">addUUID(UUID)</a> - Method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>adds hash of UUID value to the chain.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#addUUIDNull">addUUIDNull()</a> - Method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>adds hash of null UUID to the chain.</p> <p><a href="com/vertica/jdbc/DataSource.md#areBatchInsertsDirect">areBatchInsertsDirect()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get if batch inserts are direct for the data source.</p> <h2 id="b">B</h2> <p><a href="com/vertica/jdbc/kv/VerticaRoutableConnection.md#beginConsistentRead">beginConsistentRead()</a> - Method in interface com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a></p> <p>Deprecated.</p> <p>All subsequent <a href="com/vertica/jdbc/kv/VGet.md">VGet</a> accesses will read from a consistent snapshot acquired at the time this method call is made.</p> <h2 id="c">C</h2> <p><a href="com/vertica/jdbc/kv/VerticaRoutableConnection.md#clearMetadataCache">clearMetadataCache()</a> - Method in interface com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a></p> <p>Deprecated.</p> <p>Clears the cached projection metadata used by all VGets constructed by this connection.</p> <p><a href="com/vertica/jdbc/kv/VGet.md#clearOutputs">clearOutputs()</a> - Method in interface com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VGet.md">VGet</a></p> <p>Deprecated.</p> <p>Clears out all outputs added with <a href="com/vertica/jdbc/kv/VGet.md#addOutputColumn">VGet.addOutputColumn(String)</a> and <a href="com/vertica/jdbc/kv/VGet.md#addOutputExpression">VGet.addOutputExpression(String)</a>.</p> <p><a href="com/vertica/jdbc/kv/VGet.md#clearPredicates">clearPredicates()</a> - Method in interface com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VGet.md">VGet</a></p> <p>Deprecated.</p> <p>Clears out all predicates added with <a href="com/vertica/jdbc/kv/VGet.md#addPredicate">VGet.addPredicate(String, Object)</a> and <a href="com/vertica/jdbc/kv/VGet.md#addPredicateExpression">VGet.addPredicateExpression(String)</a>.</p> <p><a href="com/vertica/jdbc/kv/VGet.md#clearSortColumns">clearSortColumns()</a> - Method in interface com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VGet.md">VGet</a></p> <p>Deprecated.</p> <p>Clears out all columns added to the sort by <a href="com/vertica/jdbc/kv/VGet.md#addSortColumn">VGet.addSortColumn(String, SortOrder)</a></p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#clone">clone()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>Returns a deep copy of this VerticaDayTimeInterval.</p> <p><a href="com/vertica/jdbc/VerticaYearMonthInterval.md#clone">clone()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaYearMonthInterval.md">VerticaYearMonthInterval</a></p> <p>Returns a deep copy of this VerticaYearMonthInterval.</p> <p><a href="com/vertica/jdbc/kv/VerticaRoutableExecutor.md#close">close()</a> - Method in interface com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VerticaRoutableExecutor.md">VerticaRoutableExecutor</a></p> <p>Deprecated.</p> <p>Release resource used by this VerticaRoutableExecutor - close the result set(s)</p> <p><a href="com/vertica/jdbc/kv/VGet.md#close">close()</a> - Method in interface com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VGet.md">VGet</a></p> <p>Deprecated.</p> <p>Releases resources used by this VGet.</p> <p><a href="com/vertica/jdbc/package-summary.md">com.vertica.jdbc</a> - package com.vertica.jdbc</p> <p> </p> <p><a href="com/vertica/jdbc/kv/package-summary.md">com.vertica.jdbc.kv</a> - package com.vertica.jdbc.kv</p> <p> </p> <p><a href="com/vertica/jdbc/kv/VerticaRoutableConnection.md#createRoutableExecutor">createRoutableExecutor(String, String)</a> - Method in interface com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a></p> <p>Deprecated.</p> <p>Create a KV query executor for a table/projection.</p> <h2 id="d">D</h2> <p><a href="com/vertica/jdbc/DataSource.md">DataSource</a> - Class in <a href="com/vertica/jdbc/package-summary.md">com.vertica.jdbc</a></p> <p> </p> <p><a href="com/vertica/jdbc/DataSource.md#DataSource">DataSource()</a> - Constructor for class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p> </p> <p><a href="com/vertica/jdbc/Driver.md">Driver</a> - Class in <a href="com/vertica/jdbc/package-summary.md">com.vertica.jdbc</a></p> <p> </p> <p><a href="com/vertica/jdbc/Driver.md#Driver">Driver()</a> - Constructor for class com.vertica.jdbc.<a href="com/vertica/jdbc/Driver.md">Driver</a></p> <p> </p> <h2 id="e">E</h2> <p><a href="com/vertica/jdbc/kv/VerticaRoutableConnection.md#endConsistentRead">endConsistentRead()</a> - Method in interface com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a></p> <p>Deprecated.</p> <p>Stops using snapshot acquired by the last call to <a href="com/vertica/jdbc/kv/VerticaRoutableConnection.md#beginConsistentRead">VerticaRoutableConnection.beginConsistentRead()</a>.</p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#equals">equals(Object)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>Returns true if obj is a VerticaDayTimeInterval and it represents the same span of time as this interval, regardless of which units are set.</p> <p><a href="com/vertica/jdbc/VerticaYearMonthInterval.md#equals">equals(Object)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaYearMonthInterval.md">VerticaYearMonthInterval</a></p> <p>Returns true if obj is a VerticaYearMonthInterval and it represents the same span of time as this interval, regardless of which units are set.</p> <p><a href="com/vertica/jdbc/kv/VerticaRoutableExecutor.md#execute">execute(String, Map)</a> - Method in interface com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VerticaRoutableExecutor.md">VerticaRoutableExecutor</a></p> <p>Deprecated.</p> <p>Execute a query using these segmentation key values arguments.</p> <p><a href="com/vertica/jdbc/kv/VerticaRoutableExecutor.md#execute">execute(String, String, Object)</a> - Method in interface com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VerticaRoutableExecutor.md">VerticaRoutableExecutor</a></p> <p>Deprecated.</p> <p>Execute a query using a single column name/value pair as the routing information.</p> <p><a href="com/vertica/jdbc/kv/VGet.md#execute">execute()</a> - Method in interface com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VGet.md">VGet</a></p> <p>Deprecated.</p> <p>Fetches the desired results.</p> <p><a href="com/vertica/jdbc/VerticaCopyStream.md#execute">execute()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaCopyStream.md">VerticaCopyStream</a></p> <p> </p> <h2 id="f">F</h2> <p><a href="com/vertica/jdbc/VerticaCopyStream.md#finish">finish()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaCopyStream.md">VerticaCopyStream</a></p> <p>Finishes the copy statement.</p> <h2 id="g">G</h2> <p><a href="com/vertica/jdbc/DataSource.md#getBackupServerNode">getBackupServerNode()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get list of backup server nodes.</p> <p><a href="com/vertica/jdbc/DataSource.md#getBinaryTransfer">getBinaryTransfer()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get whether or not connection uses binary transfer</p> <p><a href="com/vertica/jdbc/DataSource.md#getConnSettings">getConnSettings()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Returns the session initialization sql that will run when a connection is established.</p> <p><a href="com/vertica/jdbc/DataSource.md#getDatabase">getDatabase()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get the database for the data source.</p> <p><a href="com/vertica/jdbc/VerticaDatabaseErrorInfo.md#getDetail">getDetail()</a> - Method in interface com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDatabaseErrorInfo.md">VerticaDatabaseErrorInfo</a></p> <p> </p> <p><a href="com/vertica/jdbc/DataSource.md#getDisableCopyLocal">getDisableCopyLocal()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Gets the value of the connection setting that determines whether file-based COPY LOCAL operations are disabled.</p> <p><a href="com/vertica/jdbc/DataSource.md#getEnableRoutableQueries">getEnableRoutableQueries()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Deprecated.</p> <p>This feature is likely to stop working in a future release and to be removed as a result.</p> <p><a href="com/vertica/jdbc/VerticaDatabaseErrorInfo.md#getErrorCode">getErrorCode()</a> - Method in interface com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDatabaseErrorInfo.md">VerticaDatabaseErrorInfo</a></p> <p> </p> <p><a href="com/vertica/jdbc/VerticaDatabaseErrorInfo.md#getErrorLevel">getErrorLevel()</a> - Method in interface com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDatabaseErrorInfo.md">VerticaDatabaseErrorInfo</a></p> <p>Returns the severity classification for the error.</p> <p><a href="com/vertica/jdbc/DataSource.md#getFailOnMultiNodePlans">getFailOnMultiNodePlans()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Deprecated.</p> <p>This feature is likely to stop working in a future release and to be removed as a result.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#getHash">getHash()</a> - Method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>returns the current hash value</p> <p><a href="com/vertica/jdbc/VerticaDatabaseErrorInfo.md#getHint">getHint()</a> - Method in interface com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDatabaseErrorInfo.md">VerticaDatabaseErrorInfo</a></p> <p> </p> <p><a href="com/vertica/jdbc/DataSource.md#getHost">getHost()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get the host for the data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#getHostNameVerifier">getHostNameVerifier()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get if TLS Mode for the data source.</p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#getIntervalType">getIntervalType()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>Gets the ODBC SQL type identifier for this interval.</p> <p><a href="com/vertica/jdbc/VerticaYearMonthInterval.md#getIntervalType">getIntervalType()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaYearMonthInterval.md">VerticaYearMonthInterval</a></p> <p>Gets the ODBC SQL type identifier for this interval.</p> <p><a href="com/vertica/jdbc/DataSource.md#getJAASConfigName">getJAASConfigName()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Gets the name of the JAAS configuration entry that will the driver will use when performing GSS authentication.</p> <p><a href="com/vertica/jdbc/DataSource.md#getKerberosHostName">getKerberosHostName()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Gets the host name portion of the kerberos service principal that identifies the Vertica server.</p> <p><a href="com/vertica/jdbc/DataSource.md#getKerberosServiceName">getKerberosServiceName()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Gets the service name portion of the kerberos service principal that identifies the Vertica server.</p> <p><a href="com/vertica/jdbc/DataSource.md#getKeyStorePassword">getKeyStorePassword()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Gets the password for the keystore file.</p> <p><a href="com/vertica/jdbc/DataSource.md#getKeyStorePath">getKeyStorePath()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Gets the path to the keystore file, or &quot;&quot; if not specified.</p> <p><a href="com/vertica/jdbc/VerticaConnection.md#getLastDatabaseError">getLastDatabaseError()</a> - Method in interface com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaConnection.md">VerticaConnection</a></p> <p>Returns information about the most recent database error that occurred on this connection.</p> <p><a href="com/vertica/jdbc/DataSource.md#getLocale">getLocale()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get the locale for the data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#getLogDirectory">getLogDirectory()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Gets the directory used to store log files</p> <p><a href="com/vertica/jdbc/DataSource.md#getLoginNetworkTimeout">getLoginNetworkTimeout()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get the LoginNetworkTimeout for the data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#getLoginNodeTimeout">getLoginNodeTimeout()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get the LoginNodeTimeout for the data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#getLoginTimeout">getLoginTimeout()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get the login timeout for the data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#getLogLevel">getLogLevel()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Gets current level of logging</p> <p><a href="com/vertica/jdbc/DataSource.md#getLogNameSpace">getLogNameSpace()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Gets package that logging is restricted to</p> <p><a href="com/vertica/jdbc/DataSource.md#getMarsEnabled">getMarsEnabled()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p> </p> <p><a href="com/vertica/jdbc/DataSource.md#getMaxPooledConnections">getMaxPooledConnections()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Deprecated.</p> <p>This feature is likely to stop working in a future release and to be removed as a result.</p> <p><a href="com/vertica/jdbc/DataSource.md#getMaxPooledConnectionsPerNode">getMaxPooledConnectionsPerNode()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Deprecated.</p> <p>This feature is likely to stop working in a future release and to be removed as a result.</p> <p><a href="com/vertica/jdbc/DataSource.md#getMaxPooledConnectionUses">getMaxPooledConnectionUses()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Deprecated.</p> <p>This feature is likely to stop working in a future release and to be removed as a result.</p> <p><a href="com/vertica/jdbc/VerticaDatabaseErrorInfo.md#getMessage">getMessage()</a> - Method in interface com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDatabaseErrorInfo.md">VerticaDatabaseErrorInfo</a></p> <p> </p> <p><a href="com/vertica/jdbc/DataSource.md#getMetadataCacheLifetime">getMetadataCacheLifetime()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Deprecated.</p> <p>This feature is likely to stop working in a future release and to be removed as a result.</p> <p><a href="com/vertica/jdbc/DataSource.md#getNetworkTimeout">getNetworkTimeout()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Gets the current network timeout value.</p> <p><a href="com/vertica/jdbc/DataSource.md#getNodeDownWaitTime">getNodeDownWaitTime()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Deprecated.</p> <p>This feature is likely to stop working in a future release and to be removed as a result.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#getNodeFor">getNodeFor(Connection, String, String, long)</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>Returns the name of the node that will be responsible for the provided value in the hash space for a given projection.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#getNodeFor">getNodeFor(String, long)</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>Given a projection's get_projection_segments() output, this method will return the node that is responsible for the provided hashValue.</p> <p><a href="com/vertica/jdbc/DataSource.md#getOAuthAccessToken">getOAuthAccessToken()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Gets the access token used for OAuth authentication.</p> <p><a href="com/vertica/jdbc/DataSource.md#getOAuthClientId">getOAuthClientId()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Gets the client ID used for OAuth authentication.</p> <p><a href="com/vertica/jdbc/DataSource.md#getOAuthClientSecret">getOAuthClientSecret()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Gets the client secret used for OAuth authentication.</p> <p><a href="com/vertica/jdbc/DataSource.md#getOAuthDiscoveryUrl">getOAuthDiscoveryUrl()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Gets the discovery url used to fetch the OAuth token endpoint.</p> <p><a href="com/vertica/jdbc/DataSource.md#getOAuthRefreshToken">getOAuthRefreshToken()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Gets the refresh token used for OAuth authentication.</p> <p><a href="com/vertica/jdbc/DataSource.md#getOAuthScope">getOAuthScope()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Gets the scope of the access request used for OAuth token refresh.</p> <p><a href="com/vertica/jdbc/DataSource.md#getOAuthTokenUrl">getOAuthTokenUrl()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Gets the token url used for OAuth authentication.</p> <p><a href="com/vertica/jdbc/DataSource.md#getParentLogger">getParentLogger()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get parent Logger of all the Loggers used by this data source.</p> <p><a href="com/vertica/jdbc/Driver.md#getParentLogger">getParentLogger()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/Driver.md">Driver</a></p> <p>Get parent Logger of all the Loggers used by this data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#getPort">getPort()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get the port for the data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#getPortInt">getPortInt()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get the port for the data source as an inteter.</p> <p><a href="com/vertica/jdbc/VerticaDatabaseErrorInfo.md#getPosition">getPosition()</a> - Method in interface com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDatabaseErrorInfo.md">VerticaDatabaseErrorInfo</a></p> <p> </p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#getPrecision">getPrecision()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p> </p> <p><a href="com/vertica/jdbc/DataSource.md#getPreferredAddressFamily">getPreferredAddressFamily()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Gets the preferred address family type to be used when resolving hostnames.</p> <p><a href="com/vertica/jdbc/VerticaConnection.md#getProperty">getProperty(String)</a> - Method in interface com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaConnection.md">VerticaConnection</a></p> <p>Returns the value of a Vertica specific property on this connection.</p> <p><a href="com/vertica/jdbc/VerticaCopyStream.md#getRejects">getRejects()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaCopyStream.md">VerticaCopyStream</a></p> <p>Returns a list of row numbers corresponding to the rows in the input streams that were rejected by the server.</p> <p><a href="com/vertica/jdbc/DataSource.md#getResultBufferSize">getResultBufferSize()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get the maximum size of the client side ResultSet cache for the data source.</p> <p><a href="com/vertica/jdbc/VerticaCopyStream.md#getRowCount">getRowCount()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaCopyStream.md">VerticaCopyStream</a></p> <p>Gets the final row count for the entire copy operation.</p> <p><a href="com/vertica/jdbc/DataSource.md#getSearchPath">getSearchPath()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get the schema search path for this data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#getSessionLabel">getSessionLabel()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get the session label for the data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#getSessionTimezone">getSessionTimezone()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get the session timezone for the data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#getSocketFactoryName">getSocketFactoryName()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get the custom socket factory name for the data source.</p> <p><a href="com/vertica/jdbc/VerticaDatabaseErrorInfo.md#getSQLState">getSQLState()</a> - Method in interface com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDatabaseErrorInfo.md">VerticaDatabaseErrorInfo</a></p> <p> </p> <p><a href="com/vertica/jdbc/DataSource.md#getSSLSocketFactoryName">getSSLSocketFactoryName()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get the custom SSL socket factory name for the data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#getStreamingBatchInsert">getStreamingBatchInsert()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Gets the value of the connection setting that determines whether the streaming or non-streaming batch insert model is used.</p> <p><a href="com/vertica/jdbc/DataSource.md#getTLSMode">getTLSMode()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get TLS Mode for the data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#getTransactionIsolation">getTransactionIsolation()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get the transaction isolation for the data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#getTrustStorePassword">getTrustStorePassword()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Gets the password for the truststore file.</p> <p><a href="com/vertica/jdbc/DataSource.md#getTrustStorePath">getTrustStorePath()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Gets the path to the truststore file, or &quot;&quot; if not specified.</p> <p><a href="com/vertica/jdbc/DataSource.md#getUser">getUser()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get current user</p> <p><a href="com/vertica/jdbc/kv/VerticaRoutableExecutor.md#getWarnings">getWarnings()</a> - Method in interface com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VerticaRoutableExecutor.md">VerticaRoutableExecutor</a></p> <p>Deprecated.</p> <p>Get SQLWarning after an <a href="com/vertica/jdbc/kv/VGet.md#execute">VGet.execute()</a> call.</p> <p><a href="com/vertica/jdbc/kv/VGet.md#getWarnings">getWarnings()</a> - Method in interface com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VGet.md">VGet</a></p> <p>Deprecated.</p> <p>Retrieves the first warning reported by calls on this VGet.</p> <h2 id="h">H</h2> <p><a href="com/vertica/jdbc/kv/VHash.md#hashBoolean">hashBoolean(boolean)</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>compute hash of boolean value</p> <p><a href="com/vertica/jdbc/kv/VHash.md#hashBooleanNull">hashBooleanNull()</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>compute hash of boolean null value</p> <p><a href="com/vertica/jdbc/kv/VHash.md#hashBytes(byte%5B%5D)">hashBytes(byte[])</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>compute hash of a binary value</p> <p><a href="com/vertica/jdbc/kv/VHash.md#hashBytesNull">hashBytesNull()</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>compute hash of a binary null value</p> <p><a href="com/vertica/jdbc/kv/VHash.md#hashBytesNull">hashBytesNull(long)</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>compute hash of a binary null value</p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#hashCode">hashCode()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>The hash code of an interval is computed first by converting the value of this interval to a number of nanoseconds.</p> <p><a href="com/vertica/jdbc/VerticaYearMonthInterval.md#hashCode">hashCode()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaYearMonthInterval.md">VerticaYearMonthInterval</a></p> <p>The hash code of an interval is calculated first by converting this interval to a number of months.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#hashDate">hashDate(Date)</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>compute hash of java.util.Date value</p> <p><a href="com/vertica/jdbc/kv/VHash.md#hashDate">hashDate(Date)</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>compute hash of java.sql.Date value</p> <p><a href="com/vertica/jdbc/kv/VHash.md#hashDouble">hashDouble(double)</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>compute hash of double value</p> <p><a href="com/vertica/jdbc/kv/VHash.md#hashDoubleNull">hashDoubleNull()</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>compute hash of double null value</p> <p><a href="com/vertica/jdbc/kv/VHash.md#hashLong">hashLong(long)</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>compute hash of long value</p> <p><a href="com/vertica/jdbc/kv/VHash.md#hashNull">hashNull(long)</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>compute hash of null value.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#hashNull">hashNull()</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>Compute hash of null value</p> <p><a href="com/vertica/jdbc/kv/VHash.md#hashNumeric">hashNumeric(BigDecimal, int)</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>compute hash of a numeric value</p> <p><a href="com/vertica/jdbc/kv/VHash.md#hashString">hashString(String)</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>compute hash of String value</p> <p><a href="com/vertica/jdbc/kv/VHash.md#hashStringNull">hashStringNull()</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>compute hash of String null value</p> <p><a href="com/vertica/jdbc/kv/VHash.md#hashTime">hashTime(Time)</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>compute hash of Time value</p> <p><a href="com/vertica/jdbc/kv/VHash.md#hashTimestamp">hashTimestamp(long)</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>compute hash of Timestamp value expressed in milliseconds since Jan 1, 1970.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#hashTimestamp">hashTimestamp(Timestamp)</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>compute hash of java.sql.Timestamp value</p> <p><a href="com/vertica/jdbc/kv/VHash.md#hashUUID">hashUUID(UUID, long)</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>compute hash of UUID value.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#hashUUIDNull">hashUUIDNull(long)</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>compute a hash of a null UUID value.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#hashUUIDNull">hashUUIDNull()</a> - Static method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>compute a hash of a null UUID value.</p> <h2 id="i">I</h2> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#INTERVAL_DAY">INTERVAL_DAY</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>Deprecated.</p> <p>superseded by <a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_DAY">VerticaTypes.INTERVAL_DAY</a></p> <p><a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_DAY">INTERVAL_DAY</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaTypes.md">VerticaTypes</a></p> <p>The ODBC SQL type identifier for an INTERVAL DAY interval.</p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#INTERVAL_DAY_TO_HOUR">INTERVAL_DAY_TO_HOUR</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>Deprecated.</p> <p>superseded by <a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_DAY_TO_HOUR">VerticaTypes.INTERVAL_DAY_TO_HOUR</a></p> <p><a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_DAY_TO_HOUR">INTERVAL_DAY_TO_HOUR</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaTypes.md">VerticaTypes</a></p> <p>The ODBC SQL type identifier for an INTERVAL DAY TO HOUR interval.</p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#INTERVAL_DAY_TO_MINUTE">INTERVAL_DAY_TO_MINUTE</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>Deprecated.</p> <p>superseded by <a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_DAY_TO_MINUTE">VerticaTypes.INTERVAL_DAY_TO_MINUTE</a></p> <p><a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_DAY_TO_MINUTE">INTERVAL_DAY_TO_MINUTE</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaTypes.md">VerticaTypes</a></p> <p>The ODBC SQL type identifier for an INTERVAL DAY TO MINUTE interval.</p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#INTERVAL_DAY_TO_SECOND">INTERVAL_DAY_TO_SECOND</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>Deprecated.</p> <p>superseded by <a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_DAY_TO_SECOND">VerticaTypes.INTERVAL_DAY_TO_SECOND</a></p> <p><a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_DAY_TO_SECOND">INTERVAL_DAY_TO_SECOND</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaTypes.md">VerticaTypes</a></p> <p>The ODBC SQL type identifier for an INTERVAL DAY TO SECOND interval.</p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#INTERVAL_HOUR">INTERVAL_HOUR</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>Deprecated.</p> <p>superseded by <a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_HOUR">VerticaTypes.INTERVAL_HOUR</a></p> <p><a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_HOUR">INTERVAL_HOUR</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaTypes.md">VerticaTypes</a></p> <p>The ODBC SQL type identifier for an INTERVAL HOUR interval.</p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#INTERVAL_HOUR_TO_MINUTE">INTERVAL_HOUR_TO_MINUTE</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>Deprecated.</p> <p>superseded by <a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_HOUR_TO_MINUTE">VerticaTypes.INTERVAL_HOUR_TO_MINUTE</a></p> <p><a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_HOUR_TO_MINUTE">INTERVAL_HOUR_TO_MINUTE</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaTypes.md">VerticaTypes</a></p> <p>The ODBC SQL type identifier for an INTERVAL HOUR TO MINUTE interval.</p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#INTERVAL_HOUR_TO_SECOND">INTERVAL_HOUR_TO_SECOND</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>Deprecated.</p> <p>superseded by <a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_HOUR_TO_SECOND">VerticaTypes.INTERVAL_HOUR_TO_SECOND</a></p> <p><a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_HOUR_TO_SECOND">INTERVAL_HOUR_TO_SECOND</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaTypes.md">VerticaTypes</a></p> <p>The ODBC SQL type identifier for an INTERVAL HOUR TO SECOND interval.</p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#INTERVAL_MINUTE">INTERVAL_MINUTE</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>Deprecated.</p> <p>superseded by <a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_MINUTE">VerticaTypes.INTERVAL_MINUTE</a></p> <p><a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_MINUTE">INTERVAL_MINUTE</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaTypes.md">VerticaTypes</a></p> <p>The ODBC SQL type identifier for an INTERVAL MINUTE interval.</p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#INTERVAL_MINUTE_TO_SECOND">INTERVAL_MINUTE_TO_SECOND</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>Deprecated.</p> <p>superseded by <a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_MINUTE_TO_SECOND">VerticaTypes.INTERVAL_MINUTE_TO_SECOND</a></p> <p><a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_MINUTE_TO_SECOND">INTERVAL_MINUTE_TO_SECOND</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaTypes.md">VerticaTypes</a></p> <p>The ODBC SQL type identifier for an INTERVAL MINUTE TO SECOND interval.</p> <p><a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_MONTH">INTERVAL_MONTH</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaTypes.md">VerticaTypes</a></p> <p>The ODBC SQL type identifier for an INTERVAL MONTH interval.</p> <p><a href="com/vertica/jdbc/VerticaYearMonthInterval.md#INTERVAL_MONTH">INTERVAL_MONTH</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaYearMonthInterval.md">VerticaYearMonthInterval</a></p> <p>Deprecated.</p> <p>superseded by <a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_MONTH">VerticaTypes.INTERVAL_MONTH</a></p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#INTERVAL_SECOND">INTERVAL_SECOND</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>Deprecated.</p> <p>superseded by <a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_SECOND">VerticaTypes.INTERVAL_SECOND</a></p> <p><a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_SECOND">INTERVAL_SECOND</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaTypes.md">VerticaTypes</a></p> <p>The ODBC SQL type identifier for an INTERVAL SECOND interval.</p> <p><a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_YEAR">INTERVAL_YEAR</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaTypes.md">VerticaTypes</a></p> <p>The ODBC SQL type identifier for an INTERVAL YEAR interval.</p> <p><a href="com/vertica/jdbc/VerticaYearMonthInterval.md#INTERVAL_YEAR">INTERVAL_YEAR</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaYearMonthInterval.md">VerticaYearMonthInterval</a></p> <p>Deprecated.</p> <p>superseded by <a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_YEAR">VerticaTypes.INTERVAL_YEAR</a></p> <p><a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_YEAR_TO_MONTH">INTERVAL_YEAR_TO_MONTH</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaTypes.md">VerticaTypes</a></p> <p>The ODBC SQL type identifier for an INTERVAL YEAR TO MONTH interval.</p> <p><a href="com/vertica/jdbc/VerticaYearMonthInterval.md#INTERVAL_YEAR_TO_MONTH">INTERVAL_YEAR_TO_MONTH</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaYearMonthInterval.md">VerticaYearMonthInterval</a></p> <p>Deprecated.</p> <p>superseded by <a href="com/vertica/jdbc/VerticaTypes.md#INTERVAL_YEAR_TO_MONTH">VerticaTypes.INTERVAL_YEAR_TO_MONTH</a></p> <p><a href="com/vertica/jdbc/DataSource.md#isAutoCommitOnByDefault">isAutoCommitOnByDefault()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get if autocommit is enabled by default for the data source.</p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#isDayTimeInterval">isDayTimeInterval(int)</a> - Static method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>A helper method to determine if the provided ODBC interval subtype identifier corresponds to one of the 10 day/time intervals that this class is capable of representing.</p> <p><a href="com/vertica/jdbc/DataSource.md#isReadOnly">isReadOnly()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get if the data source is read only.</p> <p><a href="com/vertica/jdbc/DataSource.md#isSslEnabled">isSslEnabled()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Deprecated.</p> <p><a href="com/vertica/jdbc/DataSource.md#getTLSMode">getTLSMode</a> method provide finer information.</p> <p><a href="com/vertica/jdbc/DataSource.md#isWrapperFor">isWrapperFor(Class)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p> </p> <p><a href="com/vertica/jdbc/VerticaYearMonthInterval.md#isYearMonthInterval">isYearMonthInterval(int)</a> - Static method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaYearMonthInterval.md">VerticaYearMonthInterval</a></p> <p>A helper method to determine if the provided ODBC interval subtype identifier corresponds to one of the 3 year/month intervals that this class is capable of representing.</p> <h2 id="p">P</h2> <p><a href="com/vertica/jdbc/kv/VerticaRoutableConnection.md#prepareGet">prepareGet(String, String)</a> - Method in interface com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a></p> <p>Deprecated.</p> <p>Creates a VGet for the given table or projection.</p> <h2 id="r">R</h2> <p><a href="com/vertica/jdbc/kv/VHash.md#reset">reset()</a> - Method in class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>resets hash value for next chain.</p> <h2 id="s">S</h2> <p><a href="com/vertica/jdbc/DataSource.md#setAutoCommitOnByDefault">setAutoCommitOnByDefault(boolean)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Set if autocommit is enabled by default for the data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#setBackupServerNode">setBackupServerNode(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the list of backup server nodes for this data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#setBatchInsertsDirect">setBatchInsertsDirect(boolean)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Deprecated.</p> <p>This method has been deprecated. WOS and moveout operations are no longer supported. All connections use direct batch insert.</p> <p><a href="com/vertica/jdbc/DataSource.md#setBinaryTransfer">setBinaryTransfer(boolean)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the flag that indicates whether or not to use binary transfer</p> <p><a href="com/vertica/jdbc/DataSource.md#setConnectionLoadBalance">setConnectionLoadBalance(boolean)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the flag that indicates whether or not to use native load balancing.</p> <p><a href="com/vertica/jdbc/DataSource.md#setConnSettings">setConnSettings(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>ConnSettings are sql statements that the driver will execute when a connection is made.</p> <p><a href="com/vertica/jdbc/DataSource.md#setDatabase">setDatabase(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Set the database for the data source.</p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#setDay">setDay(int)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>Sets the days component of this interval.</p> <p><a href="com/vertica/jdbc/DataSource.md#setDisableCopyLocal">setDisableCopyLocal(boolean)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the value of the connection setting that determines whether file-based COPY LOCAL operations are disabled.</p> <p><a href="com/vertica/jdbc/DataSource.md#setEnableRoutableQueries">setEnableRoutableQueries(boolean)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Deprecated.</p> <p>This feature is likely to stop working in a future release and to be removed as a result.</p> <p><a href="com/vertica/jdbc/DataSource.md#setFailOnMultiNodePlans">setFailOnMultiNodePlans(boolean)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Deprecated.</p> <p>This feature is likely to stop working in a future release and to be removed as a result.</p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#setFraction">setFraction(int, int)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>Sets the fraction component of this interval.</p> <p><a href="com/vertica/jdbc/DataSource.md#setHost">setHost(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Set the host for the data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#setHostNameVerifier">setHostNameVerifier(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Set user defined HostnameVerifier.</p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#setHour">setHour(int)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>Sets the hours component of this interval.</p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#setIsNegative">setIsNegative(boolean)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>Sets the sign of this interval.</p> <p><a href="com/vertica/jdbc/DataSource.md#setJAASConfigName">setJAASConfigName(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the name of the JAAS configuration entry that will be used when performing GSS-Kerberos authentication.</p> <p><a href="com/vertica/jdbc/DataSource.md#setKerberosHostName">setKerberosHostName(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the host name portion of the kerberos service principal that identifies the Vertica server.</p> <p><a href="com/vertica/jdbc/DataSource.md#setKerberosServiceName">setKerberosServiceName(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the service name portion of the kerberos service principal that identifies the Vertica server.</p> <p><a href="com/vertica/jdbc/DataSource.md#setKeyStorePassword">setKeyStorePassword(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the password protecting the keystore file.</p> <p><a href="com/vertica/jdbc/DataSource.md#setKeyStorePath">setKeyStorePath(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the path to a keystore file (typically in .jks format) to be used for TLS connections.</p> <p><a href="com/vertica/jdbc/kv/VGet.md#setLimit">setLimit(int)</a> - Method in interface com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VGet.md">VGet</a></p> <p>Deprecated.</p> <p>Imposes a limit on the number of rows returned by <a href="com/vertica/jdbc/kv/VGet.md#execute">VGet.execute()</a>.</p> <p><a href="com/vertica/jdbc/DataSource.md#setLocale">setLocale(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Set the locale for the data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#setLogDirectory">setLogDirectory(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the directory used to store log files.</p> <p><a href="com/vertica/jdbc/DataSource.md#setLoginNetworkTimeout">setLoginNetworkTimeout(int)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Set the loginNetworkTimeout for the data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#setLoginNodeTimeout">setLoginNodeTimeout(int)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Set the loginNodeTimeout for the data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#setLoginTimeout">setLoginTimeout(int)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Set the login timeout for the data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#setLogLevel">setLogLevel(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the log level Valid values:</p> <p>OFF (no logging) INFO WARNING TRACE ERROR DEBUG (most verbose)</p> <p>An invalid value will set log level to OFF</p> <p><a href="com/vertica/jdbc/DataSource.md#setLogNameSpace">setLogNameSpace(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the package that logging is restricted to.</p> <p><a href="com/vertica/jdbc/DataSource.md#setMarsEnabled">setMarsEnabled(boolean)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p> </p> <p><a href="com/vertica/jdbc/DataSource.md#setMaxPooledConnections">setMaxPooledConnections(int)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Deprecated.</p> <p>This feature is likely to stop working in a future release and to be removed as a result.</p> <p><a href="com/vertica/jdbc/DataSource.md#setMaxPooledConnectionsPerNode">setMaxPooledConnectionsPerNode(int)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Deprecated.</p> <p>This feature is likely to stop working in a future release and to be removed as a result.</p> <p><a href="com/vertica/jdbc/DataSource.md#setMaxPooledConnectionUses">setMaxPooledConnectionUses(int)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Deprecated.</p> <p>This feature is likely to stop working in a future release and to be removed as a result.</p> <p><a href="com/vertica/jdbc/DataSource.md#setMetadataCacheLifetime">setMetadataCacheLifetime(int)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Deprecated.</p> <p>This feature is likely to stop working in a future release and to be removed as a result.</p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#setMinute">setMinute(int)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>Sets the minutes component of this interval.</p> <p><a href="com/vertica/jdbc/VerticaYearMonthInterval.md#setMonth">setMonth(int)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaYearMonthInterval.md">VerticaYearMonthInterval</a></p> <p>Sets the months component of this interval.</p> <p><a href="com/vertica/jdbc/DataSource.md#setNetworkTimeout">setNetworkTimeout(int)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the network timeout.</p> <p><a href="com/vertica/jdbc/DataSource.md#setNodeDownWaitTime">setNodeDownWaitTime(int)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Deprecated.</p> <p>This feature is likely to stop working in a future release and to be removed as a result.</p> <p><a href="com/vertica/jdbc/DataSource.md#setOAuthAccessToken">setOAuthAccessToken(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the access token used for OAuth authentication.</p> <p><a href="com/vertica/jdbc/DataSource.md#setOAuthClientId">setOAuthClientId(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the client ID used for OAuth authentication.</p> <p><a href="com/vertica/jdbc/DataSource.md#setOAuthClientSecret">setOAuthClientSecret(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the client secret used for OAuth authentication.</p> <p><a href="com/vertica/jdbc/DataSource.md#setOAuthDiscoveryUrl">setOAuthDiscoveryUrl(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the discovery url used to fetch the OAuth token endpoint.</p> <p><a href="com/vertica/jdbc/DataSource.md#setOAuthRefreshToken">setOAuthRefreshToken(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the refresh token used for OAuth authentication.</p> <p><a href="com/vertica/jdbc/DataSource.md#setOAuthScope">setOAuthScope(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the scope of the access request used for OAuth token refresh.</p> <p><a href="com/vertica/jdbc/DataSource.md#setOAuthTokenUrl">setOAuthTokenUrl(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the token url used for OAuth authentication.</p> <p><a href="com/vertica/jdbc/DataSource.md#setPort">setPort(int)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Set the port for the data source as an integer.</p> <p><a href="com/vertica/jdbc/DataSource.md#setPort">setPort(short)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Set the port for the data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#setPreferredAddressFamily">setPreferredAddressFamily(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the address family type to prefer when the driver resolves hostnames.</p> <p><a href="com/vertica/jdbc/VerticaConnection.md#setProperty">setProperty(String, Object)</a> - Method in interface com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaConnection.md">VerticaConnection</a></p> <p>Sets a Vertica specific property on this connection.</p> <p><a href="com/vertica/jdbc/DataSource.md#setReadOnly">setReadOnly(boolean)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Set if the data source is read only.</p> <p><a href="com/vertica/jdbc/DataSource.md#setResultBufferSize">setResultBufferSize(long)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Set the maximum amount of data to cache in bytes when streaming ResultSet data.</p> <p><a href="com/vertica/jdbc/DataSource.md#setSearchPath">setSearchPath(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the schema search path for this data source.</p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#setSecond">setSecond(int)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>Sets the seconds component of this interval.</p> <p><a href="com/vertica/jdbc/DataSource.md#setSessionLabel">setSessionLabel(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Set the session label for the data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#setSessionTimezone">setSessionTimezone(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p> </p> <p><a href="com/vertica/jdbc/DataSource.md#setSocketFactoryName">setSocketFactoryName(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Set the custom socket factory name for the data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#setSslEnabled">setSslEnabled(boolean)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Deprecated.</p> <p><a href="com/vertica/jdbc/DataSource.md#setTLSMode">setTLSMode</a> provides finer grained control over the TLS connection process</p> <p><a href="com/vertica/jdbc/DataSource.md#setSSLSocketFactoryName">setSSLSocketFactoryName(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Set the custom SSL socket factory name for the data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#setStreamingBatchInsert">setStreamingBatchInsert(boolean)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the value of the connection setting that determines whether the streaming or non-streaming batch insert model is used.</p> <p><a href="com/vertica/jdbc/DataSource.md#setThreePartNaming">setThreePartNaming(boolean)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Set three part naming for the data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#setTLSMode">setTLSMode(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Set TLS Mode for data source.</p> <p><a href="com/vertica/jdbc/DataSource.md#setTrustStorePassword">setTrustStorePassword(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the password protecting the truststore file.</p> <p><a href="com/vertica/jdbc/DataSource.md#setTrustStorePath">setTrustStorePath(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the path to a truststore file (typically in .jks format) to be used for TLS connections.</p> <p><a href="com/vertica/jdbc/DataSource.md#setUser">setUser(String)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Sets the current user</p> <p><a href="com/vertica/jdbc/VerticaYearMonthInterval.md#setYear">setYear(int)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaYearMonthInterval.md">VerticaYearMonthInterval</a></p> <p>Sets the years component of this interval.</p> <p><a href="com/vertica/jdbc/VerticaCopyStream.md#start">start()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaCopyStream.md">VerticaCopyStream</a></p> <p>Starts the copy operation, optionally sending over any InputStream data that has been added to this VerticaCopyStream thus far (via <a href="com/vertica/jdbc/VerticaCopyStream.md#execute">VerticaCopyStream.execute()</a>).</p> <p><a href="com/vertica/jdbc/Driver.md#SUBPROTOCOL_NAME">SUBPROTOCOL_NAME</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/Driver.md">Driver</a></p> <p>The subprotocol is the portion of the connection string that comes after &quot;jdbc:&quot; but before the &quot;://&quot;.</p> <p><a href="com/vertica/jdbc/kv/VerticaRoutableConnection.md#supportsConsistentRead">supportsConsistentRead()</a> - Method in interface com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a></p> <p>Deprecated.</p> <p>Checks to see if the <a href="com/vertica/jdbc/kv/VerticaRoutableConnection.md#beginConsistentRead">VerticaRoutableConnection.beginConsistentRead()</a> and <a href="com/vertica/jdbc/kv/VerticaRoutableConnection.md#endConsistentRead">VerticaRoutableConnection.endConsistentRead()</a> methods are supported.</p> <h2 id="t">T</h2> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#toString">toString()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>Returns a string representation of this interval.</p> <p><a href="com/vertica/jdbc/VerticaYearMonthInterval.md#toString">toString()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaYearMonthInterval.md">VerticaYearMonthInterval</a></p> <p>Returns a string representation of this interval.</p> <h2 id="u">U</h2> <p><a href="com/vertica/jdbc/DataSource.md#unwrap">unwrap(Class)</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p> </p> <p><a href="com/vertica/jdbc/DataSource.md#useConnectionLoadBalance">useConnectionLoadBalance()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get whether or not connection load balancing is in use.</p> <p><a href="com/vertica/jdbc/DataSource.md#useThreePartNaming">useThreePartNaming()</a> - Method in class com.vertica.jdbc.<a href="com/vertica/jdbc/DataSource.md">DataSource</a></p> <p>Get if three-part naming is used for the data source.</p> <p><a href="com/vertica/jdbc/VerticaTypes.md#UUID">UUID</a> - Static variable in class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaTypes.md">VerticaTypes</a></p> <p>The ODBC SQL type identifier for a UUID.</p> <h2 id="v">V</h2> <p><a href="com/vertica/jdbc/kv/VGet.SortOrder.md#valueOf">valueOf(String)</a> - Static method in enum com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VGet.SortOrder.md">VGet.SortOrder</a></p> <p>Deprecated.</p> <p>Returns the enum constant of this type with the specified name.</p> <p><a href="com/vertica/jdbc/kv/VGet.SortOrder.md#values">values()</a> - Static method in enum com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VGet.SortOrder.md">VGet.SortOrder</a></p> <p>Deprecated.</p> <p>Returns an array containing the constants of this enum type, in the order they are declared.</p> <p><a href="com/vertica/jdbc/VerticaConnection.md">VerticaConnection</a> - Interface in <a href="com/vertica/jdbc/package-summary.md">com.vertica.jdbc</a></p> <p>This interface defines the public Vertica Analytic Database extensions to java.sql.Connection.</p> <p><a href="com/vertica/jdbc/VerticaCopyStream.md">VerticaCopyStream</a> - Class in <a href="com/vertica/jdbc/package-summary.md">com.vertica.jdbc</a></p> <p>A bulk loading utility that sends COPY FROM LOCAL STDIN data from a JDBC client to the Vertica database.</p> <p><a href="com/vertica/jdbc/VerticaCopyStream.md#VerticaCopyStream">VerticaCopyStream(VerticaConnection, String)</a> - Constructor for class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaCopyStream.md">VerticaCopyStream</a></p> <p>Creates a new VerticaCopyStream to execute the specified statement.</p> <p><a href="com/vertica/jdbc/VerticaCopyStream.md#VerticaCopyStream">VerticaCopyStream(VerticaConnection, String, InputStream)</a> - Constructor for class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaCopyStream.md">VerticaCopyStream</a></p> <p>Creates a new VerticaCopyStream to execute the specified statement.</p> <p><a href="com/vertica/jdbc/VerticaCopyStream.md#VerticaCopyStream">VerticaCopyStream(VerticaConnection, String, List)</a> - Constructor for class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaCopyStream.md">VerticaCopyStream</a></p> <p>Creates a new VerticaCopyStream to execute the specified statement.</p> <p><a href="com/vertica/jdbc/VerticaDatabaseErrorInfo.md">VerticaDatabaseErrorInfo</a> - Interface in <a href="com/vertica/jdbc/package-summary.md">com.vertica.jdbc</a></p> <p>Exposes additional information about errors that occur on the database server.</p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a> - Class in <a href="com/vertica/jdbc/package-summary.md">com.vertica.jdbc</a></p> <p>The JDBC representation of the Vertica INTERVAL DAY TO SECOND type.</p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#VerticaDayTimeInterval">VerticaDayTimeInterval(int, int, int, int, int, int, boolean)</a> - Constructor for class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p> </p> <p><a href="com/vertica/jdbc/VerticaDayTimeInterval.md#VerticaDayTimeInterval">VerticaDayTimeInterval(int, int, int, int, int, int, int, boolean)</a> - Constructor for class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaDayTimeInterval.md">VerticaDayTimeInterval</a></p> <p>Constructs a new VerticaDayTimeInterval.</p> <p><a href="com/vertica/jdbc/VerticaPreparedStatement.md">VerticaPreparedStatement</a> - Interface in <a href="com/vertica/jdbc/package-summary.md">com.vertica.jdbc</a></p> <p>This interface defines the public Vertica Analytic Database extensions to java.sql.Statement.</p> <p><a href="com/vertica/jdbc/kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a> - Interface in <a href="com/vertica/jdbc/kv/package-summary.md">com.vertica.jdbc.kv</a></p> <p>Deprecated.</p> <p>This feature is likely to stop working in a future release and to be removed as a result.</p> <p><a href="com/vertica/jdbc/kv/VerticaRoutableExecutor.md">VerticaRoutableExecutor</a> - Interface in <a href="com/vertica/jdbc/kv/package-summary.md">com.vertica.jdbc.kv</a></p> <p>Deprecated.</p> <p>This feature is likely to stop working in a future release and to be removed as a result.</p> <p><a href="com/vertica/jdbc/VerticaStatement.md">VerticaStatement</a> - Interface in <a href="com/vertica/jdbc/package-summary.md">com.vertica.jdbc</a></p> <p>This interface defines the public Vertica Analytic Database extensions to java.sql.Statement.</p> <p><a href="com/vertica/jdbc/VerticaTypes.md">VerticaTypes</a> - Class in <a href="com/vertica/jdbc/package-summary.md">com.vertica.jdbc</a></p> <p>This class defines Vertica identifiers for data types Vertica supports but which are not represented in java.sql.types.</p> <p><a href="com/vertica/jdbc/VerticaTypes.md#VerticaTypes">VerticaTypes()</a> - Constructor for class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaTypes.md">VerticaTypes</a></p> <p> </p> <p><a href="com/vertica/jdbc/VerticaYearMonthInterval.md">VerticaYearMonthInterval</a> - Class in <a href="com/vertica/jdbc/package-summary.md">com.vertica.jdbc</a></p> <p>The JDBC representation of the Vertica INTERVAL YEAR TO MONTH type.</p> <p><a href="com/vertica/jdbc/VerticaYearMonthInterval.md#VerticaYearMonthInterval">VerticaYearMonthInterval(int, int, boolean)</a> - Constructor for class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaYearMonthInterval.md">VerticaYearMonthInterval</a></p> <p>Constructs a new VerticaYearMonthInterval.</p> <p><a href="com/vertica/jdbc/VerticaYearMonthInterval.md#VerticaYearMonthInterval">VerticaYearMonthInterval(int, int, int, boolean)</a> - Constructor for class com.vertica.jdbc.<a href="com/vertica/jdbc/VerticaYearMonthInterval.md">VerticaYearMonthInterval</a></p> <p>Constructs a new VerticaYearMonthInterval.</p> <p><a href="com/vertica/jdbc/kv/VGet.md">VGet</a> - Interface in <a href="com/vertica/jdbc/kv/package-summary.md">com.vertica.jdbc.kv</a></p> <p>Deprecated.</p> <p>This feature is likely to stop working in a future release and to be removed as a result.</p> <p><a href="com/vertica/jdbc/kv/VGet.SortOrder.md">VGet.SortOrder</a> - Enum in <a href="com/vertica/jdbc/kv/package-summary.md">com.vertica.jdbc.kv</a></p> <p>Deprecated.</p> <p>Describes the ordering of result data.</p> <p><a href="com/vertica/jdbc/kv/VHash.md">VHash</a> - Class in <a href="com/vertica/jdbc/kv/package-summary.md">com.vertica.jdbc.kv</a></p> <p>Deprecated.</p> <p>This feature is likely to stop working in a future release and to be removed as a result.</p> <p><a href="com/vertica/jdbc/kv/VHash.md#VHash">VHash()</a> - Constructor for class com.vertica.jdbc.kv.<a href="com/vertica/jdbc/kv/VHash.md">VHash</a></p> <p>Deprecated.</p> <p>Creates an instance suitable for computing a hash of a chain of values, for use when a projection is segmented by multiple columns.</p> <p><a href="#_A_">A</a> <a href="#_B_">B</a> <a href="#_C_">C</a> <a href="#_D_">D</a> <a href="#_E_">E</a> <a href="#_F_">F</a> <a href="#_G_">G</a> <a href="#_H_">H</a> <a href="#_I_">I</a> <a href="#_P_">P</a> <a href="#_R_">R</a> <a href="#_S_">S</a> <a href="#_T_">T</a> <a href="#_U_">U</a> <a href="#_V_">V</a></p> /en/api-reference/jdbc-api/overview-summary/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/overview-summary/ <ul> <li><a href="com/vertica/jdbc/package-summary/">com.vertica.jdbc</a></li> <li><a href="com/vertica/jdbc/kv/package-summary/">com.vertica.jdbc.kv</a></li> </ul> /en/api-reference/jdbc-api/com/vertica/jdbc/verticaconnection/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/com/vertica/jdbc/verticaconnection/ <ul> <li>All Superinterfaces: java.lang.AutoCloseable, java.sql.Connection, java.sql.Wrapper</li> </ul> <p>All Known Subinterfaces: <a href="kv/VerticaRoutableConnection.md">VerticaRoutableConnection</a></p> <pre tabindex="0"><code>public interface VerticaConnection extends java.sql.Connection </code></pre><p>This interface defines the public Vertica Analytic Database extensions to java.sql.Connection. All Connections constructed by the Vertica JDBC driver implement VerticaStatement.</p> <h3 id="field-summary">Field Summary</h3> <h3 id="fields-inherited-from-interfacejavasqlconnection">Fields inherited from interface java.sql.Connection</h3> <p>TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE</p> <h3 id="method-summary">Method Summary</h3> <table> <thead> <tr> <th>Modifier and Type</th> <th>Method and Description</th> </tr> </thead> <tbody> <tr> <td>VerticaDatabaseErrorInfo</td> <td>getLastDatabaseError() Returns information about the most recent database error that occurred on this connection.</td> </tr> <tr> <td>java.lang.Object</td> <td>getProperty(java.lang.String name) Returns the value of a Vertica specific property on this connection.</td> </tr> <tr> <td>void</td> <td>setProperty(java.lang.String name, java.lang.Object value) Sets a Vertica specific property on this connection.</td> </tr> </tbody> </table> <h3 id="methods-inherited-from-interfacejavasqlconnection">Methods inherited from interface java.sql.Connection</h3> <p>abort, clearWarnings, close, commit, createArrayOf, createBlob, createClob, createNClob, createSQLXML, createStatement, createStatement, createStatement, createStruct, getAutoCommit, getCatalog, getClientInfo, getClientInfo, getHoldability, getMetaData, getNetworkTimeout, getSchema, getTransactionIsolation, getTypeMap, getWarnings, isClosed, isReadOnly, isValid, nativeSQL, prepareCall, prepareCall, prepareCall, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, releaseSavepoint, rollback, rollback, setAutoCommit, setCatalog, setClientInfo, setClientInfo, setHoldability, setNetworkTimeout, setReadOnly, setSavepoint, setSavepoint, setSchema, setTransactionIsolation, setTypeMap</p> <h3 id="methods-inherited-from-interfacejavasqlwrapper">Methods inherited from interface java.sql.Wrapper</h3> <p>isWrapperFor, unwrap</p> <h3 id="method-detail">Method Detail</h3> <h4 id="setproperty">setProperty</h4> <pre tabindex="0"><code>void setProperty(java.lang.String name, java.lang.Object value) throws java.sql.SQLException </code></pre><p>Sets a Vertica specific property on this connection. Normally a connection's properties are determined by the connection string when the connection is created. This method allows some properties to be changed after the Connection has been created.</p> <p>Any Statement or PreparedStatement created by this connection will inherit the property values set here. Parameters:name - The name of a connection property.value - The value of the connection property. Throws: java.sql.SQLException - If name is not a valid property name or value is not a valid property value.</p> <h4 id="getproperty">getProperty</h4> <pre tabindex="0"><code>java.lang.Object getProperty(java.lang.String name) throws java.sql.SQLException </code></pre><p>Returns the value of a Vertica specific property on this connection. Parameters:name - The name of the property to look up. <strong>Returns</strong> The value of the property, or null if the property has no value. Throws: java.sql.SQLException - If the property lookup fails because of an invalid name.</p> <h4 id="getlastdatabaseerror">getLastDatabaseError</h4> <pre tabindex="0"><code>VerticaDatabaseErrorInfo getLastDatabaseError() </code></pre><p>Returns information about the most recent database error that occurred on this connection.</p> <p>The information returned by this method may also be accessed via the v_monitor.error_messages system table.</p> <p>After a SQLException is thrown as a result of a server-side error, this method will return context information about that error.</p> <p>If the most recent operation did not throw a SQLException, or if the SQLException thrown was the result of a purely client-side error, then null is returned.</p> <p>The error information is discarded at the start of any operation that requires communication with the database server. <strong>Returns</strong> database error info instance</p> /en/api-reference/jdbc-api/com/vertica/jdbc/verticacopystream/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/com/vertica/jdbc/verticacopystream/ <ul> <li> <p>java.lang.Object</p> </li> <li> <p>com.vertica.jdbc.VerticaCopyStream</p> </li> </ul> <pre tabindex="0"><code>public class VerticaCopyStream extends java.lang.Object </code></pre><p>A bulk loading utility that sends COPY FROM LOCAL STDIN data from a JDBC client to the Vertica database. To bulk load data, provide any InputStream(s) and a COPY FROM LOCAL STDIN statement that describes the stream's format and a destination table.</p> <p>The <a href="VerticaCopyStream.md#start">start()</a> method begins a copy statement. If any streams have already been provided, they are sent at this point. The <a href="VerticaCopyStream.md#execute">execute()</a> method can optionally continue the execution. It sends any streams that have been added via <a href="VerticaCopyStream.md#addStream">addStream(InputStream)</a> since the last start() or execute() operation, Finally, to end the copy statement, and get the total number of rows added during the entire copy operation, call the <a href="VerticaCopyStream.md#finish">finish()</a> method.</p> <p>Though the start(), execute() and finish() methods are designed to work on a single copy statement open over multiple method calls, there are cases when the driver must split what is logically a single operation into multiple distinct commands.</p> <p>This utility honors the connection's autocommit setting, meaning that upon returning from the start(), execute() or finish() methods, the driver will have committed the transaction when autocommit is enabled. It is not illegal to add data streams to a VerticaCopyStream across transactions, but this will result in degraded performance, as separate ROS containers will be created on the server for each transaction's copy operation. For best performance, disable autocommit when using this utility.</p> <p>Similarly, because the driver can only allow one statement to run on a connection at a time, interleaving other statement executions between calls to start(), execute() or finish() will force the open copy statement to end, so that the other statement may execute. In this case, a new copy operation will begin upon the next call to execute() or finish(). This will create multiple ROS containers and degrade performance. Furthermore, if the copy statement does not have the NO COMMIT option, then each interleaved statement will in effect end the transaction, even when autocommit is turned off.</p> <p>To track the progress of the load, the <a href="VerticaCopyStream.md#getRejects">getRejects()</a> method returns a list of' row numbers that the server rejected. Each call to start(), execute() or finish() will send over any stream(s) added via <a href="VerticaCopyStream.md#addStream">addStream(InputStream)</a> that have not yet been sent to the server. The rejections from the streams(s) sent during the last start(), execute() or finish() operation will be available via getRejects(). This list is cleared with each new call to start(), execute() or finish().</p> <p>This class also implements Exceptions and Rejections files where, if specified in the Copy statement, the rejected rows will be written to the file designated as REJECTED DATA and the reason for rejection will be written to the designated EXCEPTIONS file. If these are specified, the driver will return an empty list with any calls to getRejects(). The rejection files will contain more detailed rejection information and can be checked instead.</p> <h3 id="constructor-summary">Constructor Summary</h3> <table> <thead> <tr> <th>Constructor and Description</th> </tr> </thead> <tbody> <tr> <td>VerticaCopyStream(VerticaConnection conn, java.lang.String copyStatement) Creates a new VerticaCopyStream to execute the specified statement.</td> </tr> <tr> <td>VerticaCopyStream(VerticaConnection conn, java.lang.String copyStatement, java.io.InputStream source) Creates a new VerticaCopyStream to execute the specified statement.</td> </tr> <tr> <td>VerticaCopyStream(VerticaConnection conn, java.lang.String copyStatement, java.util.List sources) Creates a new VerticaCopyStream to execute the specified statement.</td> </tr> </tbody> </table> <h3 id="method-summary">Method Summary</h3> <table> <thead> <tr> <th>Modifier and Type</th> <th>Method and Description</th> </tr> </thead> <tbody> <tr> <td>void</td> <td>addStream(java.io.InputStream input) Adds a stream to the list of streams to send in the copy statement.</td> </tr> <tr> <td>void</td> <td>execute()</td> </tr> <tr> <td>long</td> <td>finish() Finishes the copy statement.</td> </tr> <tr> <td>java.util.List</td> <td>getRejects() Returns a list of row numbers corresponding to the rows in the input streams that were rejected by the server.</td> </tr> <tr> <td>long</td> <td>getRowCount() Gets the final row count for the entire copy operation.</td> </tr> <tr> <td>void</td> <td>start() Starts the copy operation, optionally sending over any InputStream data that has been added to this VerticaCopyStream thus far (via execute()).</td> </tr> </tbody> </table> <h3 id="methods-inherited-from-classjavalangobject">Methods inherited from class java.lang.Object</h3> <p>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</p> <h3 id="constructor-detail">Constructor Detail</h3> <h4 id="verticacopystream">VerticaCopyStream</h4> <pre tabindex="0"><code>public VerticaCopyStream(VerticaConnection conn, java.lang.String copyStatement) throws java.sql.SQLException </code></pre><p>Creates a new VerticaCopyStream to execute the specified statement. Parameters:conn - The connection to run the copy statement on.copyStatement - A COPY FROM STDIN statement to execute. Throws: java.sql.SQLException - If creation of new copy stream fails.</p> <h4 id="verticacopystream-1">VerticaCopyStream</h4> <pre tabindex="0"><code>public VerticaCopyStream(VerticaConnection conn, java.lang.String copyStatement, java.io.InputStream source) throws java.sql.SQLException </code></pre><p>Creates a new VerticaCopyStream to execute the specified statement. Parameters:conn - The connection to run the copy statement on.copyStatement - A COPY FROM STDIN statement to execute.source - A data stream in the format expected by the copy statement. Throws: java.sql.SQLException - If creation of new copy stream fails.</p> <h4 id="verticacopystream-2">VerticaCopyStream</h4> <pre tabindex="0"><code>public VerticaCopyStream(VerticaConnection conn, java.lang.String copyStatement, java.util.List sources) throws java.sql.SQLException </code></pre><p>Creates a new VerticaCopyStream to execute the specified statement. Parameters:conn - The connection to run the copy statement on.copyStatement - A COPY FROM STDIN statement to execute.sources - A list of data streams, each in the format expected by the copy statement. The streams will be copied sequentially into the database. Throws: java.sql.SQLException - If creation of new copy stream fails.</p> <h3 id="method-detail">Method Detail</h3> <h4 id="start">start</h4> <pre tabindex="0"><code>public void start() throws java.sql.SQLException </code></pre><p>Starts the copy operation, optionally sending over any InputStream data that has been added to this VerticaCopyStream thus far (via <a href="VerticaCopyStream.md#execute">execute()</a>). The statement is left open so that more data streams can be added. Throws: java.sql.SQLException - If start operation fails.</p> <h4 id="execute">execute</h4> <pre tabindex="0"><code>public void execute() throws java.sql.SQLException </code></pre><p>Throws: java.sql.SQLException - If this COPY operation has not yet been started, or a database error occurs.</p> <h4 id="addstream">addStream</h4> <pre tabindex="0"><code>public void addStream(java.io.InputStream input) throws java.sql.SQLException </code></pre><p>Adds a stream to the list of streams to send in the copy statement. The data will be sent to the database on the next call to <a href="VerticaCopyStream.md#start">start()</a>, <a href="VerticaCopyStream.md#execute">execute()</a> or <a href="VerticaCopyStream.md#finish">finish()</a>. Parameters:input - The stream to add. Throws: java.sql.SQLException - If addStream operation fails.</p> <h4 id="finish">finish</h4> <pre tabindex="0"><code>public long finish() throws java.sql.SQLException </code></pre><p>Finishes the copy statement. If streams have been added but not yet executed, they will be executed. <strong>Returns</strong> The total number of rows that were added to the table during this COPY operation. Throws: java.sql.SQLException - If finish operation fails.</p> <h4 id="getrejects">getRejects</h4> <pre tabindex="0"><code>public java.util.List getRejects() </code></pre><p>Returns a list of row numbers corresponding to the rows in the input streams that were rejected by the server. This should be checked after each call to <a href="VerticaCopyStream.md#start">start()</a>, <a href="VerticaCopyStream.md#execute">execute()</a> or <a href="VerticaCopyStream.md#finish">finish()</a> to see which rows were rejected. When a new execution starts, the previous list of rejected rows is discarded.</p> <p>This list will be empty if EXCEPTIONS or REJECTED DATA files are specified <strong>Returns</strong> A list of row numbers that were rejected by the server during the last execution.</p> <h4 id="getrowcount">getRowCount</h4> <pre tabindex="0"><code>public long getRowCount() </code></pre><p>Gets the final row count for the entire copy operation. This will be remain zero until <a href="VerticaCopyStream.md#finish">finish()</a> has been called. <strong>Returns</strong> The total number of rows successfully copied to the database.</p> /en/api-reference/jdbc-api/com/vertica/jdbc/verticadatabaseerrorinfo/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/com/vertica/jdbc/verticadatabaseerrorinfo/ <pre tabindex="0"><code>public interface VerticaDatabaseErrorInfo </code></pre><p>Exposes additional information about errors that occur on the database server.</p> <p>When a server-side error occurs, the database may provide the the client with additional context and troubleshooting information about the error. The information available depends on the type of error that occurred.</p> <p>For example, when a SQL Syntax error occurs, the database may indicate a position within the SQL query text where the syntax was invalid, and a suggestion for altering the query text to make the query succeed.</p> <p>The information provided by this interface is also queryable in the database via the v_monitor.error_messages system table.</p> <p>This interface provides accessors to retrieve that information after an error has occurred. If the type of information was not available or relevant for the given error, the method should return null.</p> <h3 id="method-summary">Method Summary</h3> <table> <thead> <tr> <th>Modifier and Type</th> <th>Method and Description</th> </tr> </thead> <tbody> <tr> <td>java.lang.String</td> <td>getDetail()</td> </tr> <tr> <td>int</td> <td>getErrorCode()</td> </tr> <tr> <td>java.lang.String</td> <td>getErrorLevel() Returns the severity classification for the error.</td> </tr> <tr> <td>java.lang.String</td> <td>getHint()</td> </tr> <tr> <td>java.lang.String</td> <td>getMessage()</td> </tr> <tr> <td>int</td> <td>getPosition()</td> </tr> <tr> <td>java.lang.String</td> <td>getSQLState()</td> </tr> </tbody> </table> <h3 id="method-detail">Method Detail</h3> <h4 id="getmessage">getMessage</h4> <pre tabindex="0"><code>java.lang.String getMessage() </code></pre><p><strong>Returns</strong> A description of the error.</p> <h4 id="getdetail">getDetail</h4> <pre tabindex="0"><code>java.lang.String getDetail() </code></pre><p><strong>Returns</strong> Additional information about the error (optional). Null if not applicable.</p> <h4 id="gethint">getHint</h4> <pre tabindex="0"><code>java.lang.String getHint() </code></pre><p><strong>Returns</strong> A suggestion for how to resolve the error (optional). Null if not applicable.</p> <h4 id="getsqlstate">getSQLState</h4> <pre tabindex="0"><code>java.lang.String getSQLState() </code></pre><p><strong>Returns</strong> The SQLState code for this error.</p> <h4 id="geterrorcode">getErrorCode</h4> <pre tabindex="0"><code>int getErrorCode() </code></pre><p><strong>Returns</strong> A unique error code for this error.</p> <h4 id="getposition">getPosition</h4> <pre tabindex="0"><code>int getPosition() </code></pre><p><strong>Returns</strong> The position within the SQL command that caused the error. The first character is at position 1. Returns 0 if not applicable to the error.</p> <h4 id="geterrorlevel">getErrorLevel</h4> <pre tabindex="0"><code>java.lang.String getErrorLevel() </code></pre><p>Returns the severity classification for the error. Possible values are: &quot;NOTICE&quot;: The command completed but also yielded some diagnostic information. &quot;WARNING&quot;: The command completed but also yielded some warning information. &quot;ERROR&quot;: The error caused the command the fail. &quot;ROLLBACK&quot;: The error caused the current transaction to roll back. &quot;FATAL&quot;: The error caused the database server to end the client's session. &quot;PANIC&quot;: The error caused the database server to shut down. <strong>Returns</strong> The severity of the error.</p> /en/api-reference/jdbc-api/com/vertica/jdbc/verticadaytimeinterval/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/com/vertica/jdbc/verticadaytimeinterval/ <ul> <li> <p>java.lang.Object</p> </li> <li> <p>com.vertica.dsi.dataengine.utilities.DSITimeSpan</p> </li> <li> <p>com.vertica.jdbc.VerticaDayTimeInterval</p> </li> <li> <p>All Implemented Interfaces: java.lang.Cloneable</p> </li> </ul> <pre tabindex="0"><code>public class VerticaDayTimeInterval extends com.vertica.dsi.dataengine.utilities.DSITimeSpan implements java.lang.Cloneable </code></pre><p>The JDBC representation of the Vertica INTERVAL DAY TO SECOND type. It represents a span of time measured in days, hours, minutes, seconds and nanoseconds.</p> <p>The JDBC specification does not define first class support for interval data types. There are no java.sql.Types type identifiers for intervals, there is no built in setter on the PreparedStatement interface and no built in getter on the ResultSet interface.</p> <p>Instead, the Vertica JDBC driver follows the ODBC standard when it can. Each of the 10 day/time interval ranges is identified by the ODBC standard SQL type identifier. Those identifiers are recreated as integer fields in this class, analogous to those defined for the other data types by java.sql.Types.</p> <p>To insert a day/time interval into the database, create an instance of this class and pass it to PreparedStatement.setObject, optionally passing one of the ODBC SQL types defined by this class as the target type parameter.</p> <p>To retrieve a VericaDayTimeInterval from the database, select an INTERVAL DAY TO SECOND column, call ResultSet.getObject and cast the result to a VerticaDayTimeInterval</p> <h3 id="field-summary">Field Summary</h3> <table> <thead> <tr> <th>Modifier and Type</th> <th>Field and Description</th> </tr> </thead> <tbody> <tr> <td>static int</td> <td>INTERVAL_DAY Deprecated. superseded by VerticaTypes.INTERVAL_DAY</td> </tr> <tr> <td>static int</td> <td>INTERVAL_DAY_TO_HOUR Deprecated. superseded by VerticaTypes.INTERVAL_DAY_TO_HOUR</td> </tr> <tr> <td>static int</td> <td>INTERVAL_DAY_TO_MINUTE Deprecated. superseded by VerticaTypes.INTERVAL_DAY_TO_MINUTE</td> </tr> <tr> <td>static int</td> <td>INTERVAL_DAY_TO_SECOND Deprecated. superseded by VerticaTypes.INTERVAL_DAY_TO_SECOND</td> </tr> <tr> <td>static int</td> <td>INTERVAL_HOUR Deprecated. superseded by VerticaTypes.INTERVAL_HOUR</td> </tr> <tr> <td>static int</td> <td>INTERVAL_HOUR_TO_MINUTE Deprecated. superseded by VerticaTypes.INTERVAL_HOUR_TO_MINUTE</td> </tr> <tr> <td>static int</td> <td>INTERVAL_HOUR_TO_SECOND Deprecated. superseded by VerticaTypes.INTERVAL_HOUR_TO_SECOND</td> </tr> <tr> <td>static int</td> <td>INTERVAL_MINUTE Deprecated. superseded by VerticaTypes.INTERVAL_MINUTE</td> </tr> <tr> <td>static int</td> <td>INTERVAL_MINUTE_TO_SECOND Deprecated. superseded by VerticaTypes.INTERVAL_MINUTE_TO_SECOND</td> </tr> <tr> <td>static int</td> <td>INTERVAL_SECOND Deprecated. superseded by VerticaTypes.INTERVAL_SECOND</td> </tr> </tbody> </table> <h3 id="constructor-summary">Constructor Summary</h3> <table> <thead> <tr> <th>Constructor and Description</th> </tr> </thead> <tbody> <tr> <td>VerticaDayTimeInterval(int day, int hour, int minute, int second, int fraction, int fracPrecision, boolean isNegative)</td> </tr> <tr> <td>VerticaDayTimeInterval(int type, int day, int hour, int minute, int second, int fraction, int fracPrecision, boolean isNegative) Constructs a new VerticaDayTimeInterval.</td> </tr> </tbody> </table> <h3 id="method-summary">Method Summary</h3> <table> <thead> <tr> <th>Modifier and Type</th> <th>Method and Description</th> </tr> </thead> <tbody> <tr> <td>VerticaDayTimeInterval</td> <td>clone() Returns a deep copy of this VerticaDayTimeInterval.</td> </tr> <tr> <td>boolean</td> <td>equals(java.lang.Object obj) Returns true if obj is a VerticaDayTimeInterval and it represents the same span of time as this interval, regardless of which units are set.</td> </tr> <tr> <td>int</td> <td>getIntervalType() Gets the ODBC SQL type identifier for this interval.</td> </tr> <tr> <td>int</td> <td>getPrecision()</td> </tr> <tr> <td>int</td> <td>hashCode() The hash code of an interval is computed first by converting the value of this interval to a number of nanoseconds.</td> </tr> <tr> <td>static boolean</td> <td>isDayTimeInterval(int type) A helper method to determine if the provided ODBC interval subtype identifier corresponds to one of the 10 day/time intervals that this class is capable of representing.</td> </tr> <tr> <td>void</td> <td>setDay(int day) Sets the days component of this interval.</td> </tr> <tr> <td>void</td> <td>setFraction(int fraction, int precision) Sets the fraction component of this interval.</td> </tr> <tr> <td>void</td> <td>setHour(int hour) Sets the hours component of this interval.</td> </tr> <tr> <td>void</td> <td>setIsNegative(boolean isNegative) Sets the sign of this interval.</td> </tr> <tr> <td>void</td> <td>setMinute(int minute) Sets the minutes component of this interval.</td> </tr> <tr> <td>void</td> <td>setSecond(int second) Sets the seconds component of this interval.</td> </tr> <tr> <td>java.lang.String</td> <td>toString() Returns a string representation of this interval.</td> </tr> </tbody> </table> <h3 id="methods-inherited-from-classcomverticadsidataengineutilitiesdsitimespan">Methods inherited from class com.vertica.dsi.dataengine.utilities.DSITimeSpan</h3> <p>getDay, getFraction, getHour, getMinute, getSecond, isNegative, setFraction</p> <h3 id="methods-inherited-from-classjavalangobject">Methods inherited from class java.lang.Object</h3> <p>getClass, notify, notifyAll, wait, wait, wait</p> <h3 id="field-detail">Field Detail</h3> <h4 id="interval_day">INTERVAL_DAY</h4> <pre tabindex="0"><code>public static final int INTERVAL_DAY </code></pre><p>Deprecated. superseded by <a href="VerticaTypes.md#INTERVAL_DAY">VerticaTypes.INTERVAL_DAY</a> The ODBC SQL type identifier for an INTERVAL DAY interval. See Also:Constant Field Values</p> <h4 id="interval_day_to_hour">INTERVAL_DAY_TO_HOUR</h4> <pre tabindex="0"><code>public static final int INTERVAL_DAY_TO_HOUR </code></pre><p>Deprecated. superseded by <a href="VerticaTypes.md#INTERVAL_DAY_TO_HOUR">VerticaTypes.INTERVAL_DAY_TO_HOUR</a> The ODBC SQL type identifier for an INTERVAL DAY TO HOUR interval. See Also:Constant Field Values</p> <h4 id="interval_day_to_minute">INTERVAL_DAY_TO_MINUTE</h4> <pre tabindex="0"><code>public static final int INTERVAL_DAY_TO_MINUTE </code></pre><p>Deprecated. superseded by <a href="VerticaTypes.md#INTERVAL_DAY_TO_MINUTE">VerticaTypes.INTERVAL_DAY_TO_MINUTE</a> The ODBC SQL type identifier for an INTERVAL DAY TO MINUTE interval. See Also:Constant Field Values</p> <h4 id="interval_day_to_second">INTERVAL_DAY_TO_SECOND</h4> <pre tabindex="0"><code>public static final int INTERVAL_DAY_TO_SECOND </code></pre><p>Deprecated. superseded by <a href="VerticaTypes.md#INTERVAL_DAY_TO_SECOND">VerticaTypes.INTERVAL_DAY_TO_SECOND</a> The ODBC SQL type identifier for an INTERVAL DAY TO SECOND interval. See Also:Constant Field Values</p> <h4 id="interval_hour">INTERVAL_HOUR</h4> <pre tabindex="0"><code>public static final int INTERVAL_HOUR </code></pre><p>Deprecated. superseded by <a href="VerticaTypes.md#INTERVAL_HOUR">VerticaTypes.INTERVAL_HOUR</a> The ODBC SQL type identifier for an INTERVAL HOUR interval. See Also:Constant Field Values</p> <h4 id="interval_hour_to_minute">INTERVAL_HOUR_TO_MINUTE</h4> <pre tabindex="0"><code>public static final int INTERVAL_HOUR_TO_MINUTE </code></pre><p>Deprecated. superseded by <a href="VerticaTypes.md#INTERVAL_HOUR_TO_MINUTE">VerticaTypes.INTERVAL_HOUR_TO_MINUTE</a> The ODBC SQL type identifier for an INTERVAL HOUR TO MINUTE interval. See Also:Constant Field Values</p> <h4 id="interval_hour_to_second">INTERVAL_HOUR_TO_SECOND</h4> <pre tabindex="0"><code>public static final int INTERVAL_HOUR_TO_SECOND </code></pre><p>Deprecated. superseded by <a href="VerticaTypes.md#INTERVAL_HOUR_TO_SECOND">VerticaTypes.INTERVAL_HOUR_TO_SECOND</a> The ODBC SQL type identifier for an INTERVAL HOUR TO SECOND interval. See Also:Constant Field Values</p> <h4 id="interval_minute">INTERVAL_MINUTE</h4> <pre tabindex="0"><code>public static final int INTERVAL_MINUTE </code></pre><p>Deprecated. superseded by <a href="VerticaTypes.md#INTERVAL_MINUTE">VerticaTypes.INTERVAL_MINUTE</a> The ODBC SQL type identifier for an INTERVAL MINUTE interval. See Also:Constant Field Values</p> <h4 id="interval_minute_to_second">INTERVAL_MINUTE_TO_SECOND</h4> <pre tabindex="0"><code>public static final int INTERVAL_MINUTE_TO_SECOND </code></pre><p>Deprecated. superseded by <a href="VerticaTypes.md#INTERVAL_MINUTE_TO_SECOND">VerticaTypes.INTERVAL_MINUTE_TO_SECOND</a> The ODBC SQL type identifier for an INTERVAL MINUTE TO SECOND interval. See Also:Constant Field Values</p> <h4 id="interval_second">INTERVAL_SECOND</h4> <pre tabindex="0"><code>public static final int INTERVAL_SECOND </code></pre><p>Deprecated. superseded by <a href="VerticaTypes.md#INTERVAL_SECOND">VerticaTypes.INTERVAL_SECOND</a> The ODBC SQL type identifier for an INTERVAL SECOND interval. See Also:Constant Field Values</p> <h3 id="constructor-detail">Constructor Detail</h3> <h4 id="verticadaytimeinterval">VerticaDayTimeInterval</h4> <pre tabindex="0"><code>public VerticaDayTimeInterval(int day, int hour, int minute, int second, int fraction, int fracPrecision, boolean isNegative) </code></pre><h4 id="verticadaytimeinterval-1">VerticaDayTimeInterval</h4> <pre tabindex="0"><code>public VerticaDayTimeInterval(int type, int day, int hour, int minute, int second, int fraction, int fracPrecision, boolean isNegative) </code></pre><p>Constructs a new VerticaDayTimeInterval. Parameters:type - The ODBC SQL type identifier for this interval.day - The number of days in this interval. Must be no less than zero.hour - The number of hours in this interval. Must be no less than zero.minute - The number of minutes in this interval. Must be no less than zero.second - The number of seconds in this interval. Must be no less than zero.fraction - The fractional seconds in this interval. Must be no less than zero.fracPrecision - The precision of the fractional seconds, 6 or less (database can't store more).isNegative - True if this interval is negative, false if positive. Throws: java.lang.IllegalArgumentException - If any of the parameters are negative, or if type is not one of the ODBC SQL type identifiers defined by this class.</p> <h3 id="method-detail">Method Detail</h3> <h4 id="getprecision">getPrecision</h4> <pre tabindex="0"><code>public int getPrecision() </code></pre><h4 id="setday">setDay</h4> <pre tabindex="0"><code>public void setDay(int day) </code></pre><p>Sets the days component of this interval. If this interval has no day component, it will be converted to the closest unit representable by the type. Any fraction on the converted value is rounded down.</p> <p><strong>Overrides</strong> setDay in class com.vertica.dsi.dataengine.utilities.DSITimeSpan Parameters:day - A positive number of days. Throws: java.lang.IllegalArgumentException - If day is negative, or if using this many days would cause the interval to overflow.</p> <h4 id="sethour">setHour</h4> <pre tabindex="0"><code>public void setHour(int hour) </code></pre><p>Sets the hours component of this interval. If this interval has no hour component, it will be converted to the closest unit representable by the type. Any fraction on the converted value is rounded down.</p> <p><strong>Overrides</strong> setHour in class com.vertica.dsi.dataengine.utilities.DSITimeSpan Parameters:hour - A positive number of hours. Throws: java.lang.IllegalArgumentException - If hour is negative, or if using this many hours would cause the interval to overflow.</p> <h4 id="setminute">setMinute</h4> <pre tabindex="0"><code>public void setMinute(int minute) </code></pre><p>Sets the minutes component of this interval. If this interval has no minute component, it will be converted to the closest unit representable by the type. Any fraction on the converted value is rounded down.</p> <p><strong>Overrides</strong> setMinute in class com.vertica.dsi.dataengine.utilities.DSITimeSpan Parameters:minute - A positive number of minutes. Throws: java.lang.IllegalArgumentException - If minute is negative, or if using this many minutes would cause the interval to overflow.</p> <h4 id="setsecond">setSecond</h4> <pre tabindex="0"><code>public void setSecond(int second) </code></pre><p>Sets the seconds component of this interval. If this interval has no minute component, it will be converted to the closest unit representable by the type. Any fraction on the converted value is rounded down.</p> <p><strong>Overrides</strong> setSecond in class com.vertica.dsi.dataengine.utilities.DSITimeSpan Parameters:second - A positive number of seconds. Throws: java.lang.IllegalArgumentException - If second is negative, or if using this many seconds would cause the interval to overflow.</p> <h4 id="setfraction">setFraction</h4> <pre tabindex="0"><code>public void setFraction(int fraction, int precision) </code></pre><p>Sets the fraction component of this interval. If this interval has no fraction component, it will be converted to the closest unit representable by the type. Parameters:fraction - A positive number of microseconds.precision - The precision to use for this interval. Throws: java.lang.IllegalArgumentException - If fraction is negative, or if using this many microseconds would cause the interval to overflow.</p> <h4 id="setisnegative">setIsNegative</h4> <pre tabindex="0"><code>public void setIsNegative(boolean isNegative) </code></pre><p>Sets the sign of this interval.</p> <p><strong>Overrides</strong> setIsNegative in class com.vertica.dsi.dataengine.utilities.DSITimeSpan Parameters:isNegative - true if this interval is negative, false otherwise.</p> <h4 id="hashcode">hashCode</h4> <pre tabindex="0"><code>public int hashCode() </code></pre><p>The hash code of an interval is computed first by converting the value of this interval to a number of nanoseconds. Since the hash code must fit in an integer, It is possible that this calculation will overflow. Regardless of whether or not there was overflow, this number is then multiplied by -1 if this interval negative.</p> <p><strong>Overrides</strong> hashCode in class com.vertica.dsi.dataengine.utilities.DSITimeSpan <strong>Returns</strong> A hash code for this interval.</p> <h4 id="equals">equals</h4> <pre tabindex="0"><code>public boolean equals(java.lang.Object obj) </code></pre><p>Returns true if obj is a VerticaDayTimeInterval and it represents the same span of time as this interval, regardless of which units are set.</p> <p><strong>Overrides</strong> equals in class com.vertica.dsi.dataengine.utilities.DSITimeSpan Parameters:obj - An object to compare. <strong>Returns</strong> true if obj has the same sign, day, hour, minute, second and fraction as this interval.</p> <h4 id="clone">clone</h4> <pre tabindex="0"><code>public VerticaDayTimeInterval clone() </code></pre><p>Returns a deep copy of this VerticaDayTimeInterval. Equivalent to calling new VerticaDayTimeInterval(getIntervalType(), getDay(), getHour(), getMinute(), getSecond(), getFraction(), isNegative())</p> <p><strong>Overrides</strong> clone in class com.vertica.dsi.dataengine.utilities.DSITimeSpan <strong>Returns</strong> A copy of this interval.</p> <h4 id="tostring">toString</h4> <pre tabindex="0"><code>public java.lang.String toString() </code></pre><p>Returns a string representation of this interval. The format of this string is the same format that is recognized by the driver and database. Fields outside this interval's range (as defined by the ODBC type identifier) are not included in the String.</p> <p><strong>Overrides</strong> toString in class com.vertica.dsi.dataengine.utilities.DSITimeSpan <strong>Returns</strong> The string representation of this interval.</p> <h4 id="getintervaltype">getIntervalType</h4> <pre tabindex="0"><code>public int getIntervalType() </code></pre><p>Gets the ODBC SQL type identifier for this interval. An interval's range can be determined by comparing the return value of this method with the INTERVAL_* constants defined in this class.</p> <p><strong>Overrides</strong> getIntervalType in class com.vertica.dsi.dataengine.utilities.DSITimeSpan <strong>Returns</strong> The ODBC SQL type identifier for this interval.</p> <h4 id="isdaytimeinterval">isDayTimeInterval</h4> <pre tabindex="0"><code>public static boolean isDayTimeInterval(int type) </code></pre><p>A helper method to determine if the provided ODBC interval subtype identifier corresponds to one of the 10 day/time intervals that this class is capable of representing.</p> <p>The SQL_DATETIME_SUB column of the ResultSet returned by DatabaseMetaData.getColumns() will contain an ODBC interval subtype when the column is an interval. When this happens, the object returned by the driver when selecting that column will be a VerticaDayTimeInterval when the subtype is one of the 10 interval subtypes defined in this class. This helper method checks the provided type to see if it matches one of those 10 types. Parameters:type - An ODBC interval subtype identifier. <strong>Returns</strong> true if type corresponds to one of the 10 day/time interval types representable by a VerticaDayTimeInterval.</p> /en/api-reference/jdbc-api/com/vertica/jdbc/verticapreparedstatement/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/com/vertica/jdbc/verticapreparedstatement/ <ul> <li>All Superinterfaces: java.lang.AutoCloseable, java.sql.PreparedStatement, java.sql.Statement, java.sql.Wrapper</li> </ul> <pre tabindex="0"><code>public interface VerticaPreparedStatement extends java.sql.PreparedStatement </code></pre><p>This interface defines the public Vertica Analytic Database extensions to java.sql.Statement. All PreparedStatements constructed by the Vertica JDBC driver implement VerticaPreparedStatement.</p> <h3 id="field-summary">Field Summary</h3> <h3 id="fields-inherited-from-interfacejavasqlstatement">Fields inherited from interface java.sql.Statement</h3> <p>CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO</p> <h3 id="method-summary">Method Summary</h3> <h3 id="methods-inherited-from-interfacejavasqlpreparedstatement">Methods inherited from interface java.sql.PreparedStatement</h3> <p>addBatch, clearParameters, execute, executeLargeUpdate, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setObject, setObject, setObject, setObject, setObject, setRef, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL</p> <h3 id="methods-inherited-from-interfacejavasqlstatement">Methods inherited from interface java.sql.Statement</h3> <p>addBatch, cancel, clearBatch, clearWarnings, close, closeOnCompletion, execute, execute, execute, execute, executeBatch, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout</p> <h3 id="methods-inherited-from-interfacejavasqlwrapper">Methods inherited from interface java.sql.Wrapper</h3> <p>isWrapperFor, unwrap</p> /en/api-reference/jdbc-api/com/vertica/jdbc/kv/verticaroutableconnection/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/com/vertica/jdbc/kv/verticaroutableconnection/ <ul> <li>All Superinterfaces: java.lang.AutoCloseable, java.sql.Connection, <a href="../VerticaConnection.md">VerticaConnection</a>, java.sql.Wrapper</li> </ul> <p>Deprecated.  This feature is likely to stop working in a future release and to be removed as a result.</p> <pre tabindex="0"><code>@Deprecated public interface VerticaRoutableConnection extends VerticaConnection </code></pre><p>Provides advanced routing capabilities beyond those of a normal <a href="../VerticaConnection.md">VerticaConnection</a>. The VerticaRoutableConnection provides access to the <a href="VGet.md">VGet</a>, which performs efficient key-based lookups. Connections returned by the driver will implement this interface when the EnableRoutableQueries connection property is set to true.</p> <p>The VerticaRoutableConnection maintains an internal pool of connections and a cache of table metadata that is shared by all <a href="VGet.md">VGet</a>s that are produced by this connection's <a href="VerticaRoutableConnection.md#prepareGet">prepareGet(String, String)</a> method. It is also a fully-fledged JDBC connection on its own. It supports all the functionality that a <a href="../VerticaConnection.md">VerticaConnection</a> supports. When this connection is closed, all pooled connections managed by this VerticaRoutableConnection and all child <a href="VGet.md">VGet</a>s are closed too.</p> <p>By default, a VerticaRoutableConnection's internal pool will use no more than 20 concurrent connections to a cluster and no more than 5 concurrent connections to a given node (these are in addition to the single connection used for normal JDBC Connection operations). Those numbers can be overridden with the MaxPooledConnections and MaxPooledConnectionsPerNode connection properties. Using a large number of connections can improve <a href="VGet.md">VGet</a> performance, but it can be taxing to keep many connections open on a busy cluster. It is important for users to configure these numbers optimally for their cluster's workload.</p> <p>Because VGet operations utilize multiple JDBC connections (and multiple Vertica sessions), they can not honor the connection's JDBC transaction semantics. If consistency across multiple <a href="VGet.md">VGet</a> operations is required, history must be enabled. Only <a href="VGet.md">VGet</a> operations that have this limitation; other operations on this connection do follow normal transaction semantics.</p> <p>The <a href="VerticaRoutableConnection.md#supportsConsistentRead">supportsConsistentRead()</a> method can be used to check if history is enabled. When <a href="VerticaRoutableConnection.md#supportsConsistentRead">supportsConsistentRead()</a> returns true, the <a href="VerticaRoutableConnection.md#beginConsistentRead">beginConsistentRead()</a> and <a href="VerticaRoutableConnection.md#endConsistentRead">endConsistentRead()</a> methods can be used to guarantee that all child VGet operations occur at the same epoch.</p> <h3 id="field-summary">Field Summary</h3> <h3 id="fields-inherited-from-interfacejavasqlconnection">Fields inherited from interface java.sql.Connection</h3> <p>TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE</p> <h3 id="method-summary">Method Summary</h3> <table> <thead> <tr> <th>Modifier and Type</th> <th>Method and Description</th> </tr> </thead> <tbody> <tr> <td>void</td> <td>beginConsistentRead() Deprecated. All subsequent VGet accesses will read from a consistent snapshot acquired at the time this method call is made.</td> </tr> <tr> <td>void</td> <td>clearMetadataCache() Deprecated. Clears the cached projection metadata used by all VGets constructed by this connection.</td> </tr> <tr> <td>VerticaRoutableExecutor</td> <td>createRoutableExecutor(java.lang.String schema, java.lang.String tableOrProjection) Deprecated. Create a KV query executor for a table/projection.</td> </tr> <tr> <td>void</td> <td>endConsistentRead() Deprecated. Stops using snapshot acquired by the last call to beginConsistentRead().</td> </tr> <tr> <td>VGet</td> <td>prepareGet(java.lang.String schema, java.lang.String tableOrProj) Deprecated. Creates a VGet for the given table or projection.</td> </tr> <tr> <td>boolean</td> <td>supportsConsistentRead() Deprecated. Checks to see if the beginConsistentRead() and endConsistentRead() methods are supported.</td> </tr> </tbody> </table> <h3 id="methods-inherited-from-interfacecomverticajdbcverticaconnectionverticaconnectionmd">Methods inherited from interface com.vertica.jdbc.<a href="../VerticaConnection.md">VerticaConnection</a></h3> <p><a href="../VerticaConnection.md#getLastDatabaseError">getLastDatabaseError</a>, <a href="../VerticaConnection.md#getProperty">getProperty</a>, <a href="../VerticaConnection.md#setProperty">setProperty</a></p> <h3 id="methods-inherited-from-interfacejavasqlconnection">Methods inherited from interface java.sql.Connection</h3> <p>abort, clearWarnings, close, commit, createArrayOf, createBlob, createClob, createNClob, createSQLXML, createStatement, createStatement, createStatement, createStruct, getAutoCommit, getCatalog, getClientInfo, getClientInfo, getHoldability, getMetaData, getNetworkTimeout, getSchema, getTransactionIsolation, getTypeMap, getWarnings, isClosed, isReadOnly, isValid, nativeSQL, prepareCall, prepareCall, prepareCall, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, releaseSavepoint, rollback, rollback, setAutoCommit, setCatalog, setClientInfo, setClientInfo, setHoldability, setNetworkTimeout, setReadOnly, setSavepoint, setSavepoint, setSchema, setTransactionIsolation, setTypeMap</p> <h3 id="methods-inherited-from-interfacejavasqlwrapper">Methods inherited from interface java.sql.Wrapper</h3> <p>isWrapperFor, unwrap</p> <h3 id="method-detail">Method Detail</h3> <h4 id="prepareget">prepareGet</h4> <pre tabindex="0"><code>VGet prepareGet(java.lang.String schema, java.lang.String tableOrProj) throws java.sql.SQLException </code></pre><p>Deprecated.  Creates a VGet for the given table or projection. Parameters:schema - The schema name of the table or projection to get values from.tableOrProj - The name of a table or projection to get values from. <strong>Returns</strong> A VGet instance for the provided table/projection. Throws: java.sql.SQLException - Thrown if the schema or table does not exist, or if a database access error occurs.</p> <h4 id="clearmetadatacache">clearMetadataCache</h4> <pre tabindex="0"><code>void clearMetadataCache() throws java.sql.SQLException </code></pre><p>Deprecated.  Clears the cached projection metadata used by all VGets constructed by this connection. Throws: java.sql.SQLException - Thrown if a database access error occurs.</p> <h4 id="supportsconsistentread">supportsConsistentRead</h4> <pre tabindex="0"><code>boolean supportsConsistentRead() throws java.sql.SQLException </code></pre><p>Deprecated.  Checks to see if the <a href="VerticaRoutableConnection.md#beginConsistentRead">beginConsistentRead()</a> and <a href="VerticaRoutableConnection.md#endConsistentRead">endConsistentRead()</a> methods are supported. To support consistent reads, historical queries must be enabled in the database. <strong>Returns</strong> true if history retention is enabled on this database cluster. Throws: java.sql.SQLException - Thrown if a database access error occurs.See Also:<a href="VerticaRoutableConnection.md#beginConsistentRead">beginConsistentRead()</a>, <a href="VerticaRoutableConnection.md#endConsistentRead">endConsistentRead()</a></p> <h4 id="beginconsistentread">beginConsistentRead</h4> <pre tabindex="0"><code>void beginConsistentRead() throws java.sql.SQLException </code></pre><p>Deprecated.  All subsequent <a href="VGet.md">VGet</a> accesses will read from a consistent snapshot acquired at the time this method call is made.</p> <p>Care must be taken to configure Vertica to maintain historical snapshots (see AHM management in the Vertica documentation). If Vertica invalidates the snapshot, subsequent accesses will fail with error &quot;Can't run historical queries at epochs prior to the Ancient History Mark&quot; Throws: java.sql.SQLException - Thrown if snapshot cannot be acquired or if a database access error occurs.See Also:<a href="VerticaRoutableConnection.md#endConsistentRead">endConsistentRead()</a></p> <h4 id="endconsistentread">endConsistentRead</h4> <pre tabindex="0"><code>void endConsistentRead() throws java.sql.SQLException </code></pre><p>Deprecated.  Stops using snapshot acquired by the last call to <a href="VerticaRoutableConnection.md#beginConsistentRead">beginConsistentRead()</a>. Throws: java.sql.SQLException - Thrown if a database access error occurs.See Also:<a href="VerticaRoutableConnection.md#beginConsistentRead">beginConsistentRead()</a></p> <h4 id="createroutableexecutor">createRoutableExecutor</h4> <pre tabindex="0"><code>VerticaRoutableExecutor createRoutableExecutor(java.lang.String schema, java.lang.String tableOrProjection) throws java.sql.SQLException </code></pre><p>Deprecated.  Create a KV query executor for a table/projection. Parameters:schema - The schema name of the table or projection to get values from.tableOrProjection - The name of a table or projection to get values from. <strong>Returns</strong> a routable executor instance Throws: java.sql.SQLException - Thrown if a database access error occurs.</p> /en/api-reference/jdbc-api/com/vertica/jdbc/kv/verticaroutableexecutor/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/com/vertica/jdbc/kv/verticaroutableexecutor/ <ul> <li>Deprecated.  This feature is likely to stop working in a future release and to be removed as a result.</li> </ul> <pre tabindex="0"><code>@Deprecated public interface VerticaRoutableExecutor </code></pre><p>An alternate API for KV queries that takes a SQL query as an argument, plus the column/value bindings that are necessary to compute the targeted node. Simply call the <a href="VerticaRoutableExecutor.md#execute">execute(String, Map)</a> method (or, if there is only one column name/value pair, <a href="VerticaRoutableExecutor.md#execute">execute(String, String, Object)</a>) to run query.</p> <p>Both VerticaRoutableExecutor and the <a href="VGet.md">VGet</a> API uses the same internal operations to route the queries.</p> <h3 id="method-summary">Method Summary</h3> <table> <thead> <tr> <th>Modifier and Type</th> <th>Method and Description</th> </tr> </thead> <tbody> <tr> <td>void</td> <td>close() Deprecated. Release resource used by this VerticaRoutableExecutor - close the result set(s)</td> </tr> <tr> <td>java.sql.ResultSet</td> <td>execute(java.lang.String sql, java.util.Map segKey) Deprecated. Execute a query using these segmentation key values arguments.</td> </tr> <tr> <td>java.sql.ResultSet</td> <td>execute(java.lang.String sql, java.lang.String segCol, java.lang.Object value) Deprecated. Execute a query using a single column name/value pair as the routing information.</td> </tr> <tr> <td>java.sql.SQLWarning</td> <td>getWarnings() Deprecated. Get SQLWarning after an VGet.execute() call.</td> </tr> </tbody> </table> <h3 id="method-detail">Method Detail</h3> <h4 id="execute">execute</h4> <pre tabindex="0"><code>java.sql.ResultSet execute(java.lang.String sql, java.util.Map segKey) throws java.sql.SQLException </code></pre><p>Deprecated.  Execute a query using these segmentation key values arguments. Parameters:sql - The query to be routed.segKey - The map containing column name/value pairs. <strong>Returns</strong> the result set created by the routable query. Throws: java.sql.SQLException - Query not routable or has failed.</p> <h4 id="execute-1">execute</h4> <pre tabindex="0"><code>java.sql.ResultSet execute(java.lang.String sql, java.lang.String segCol, java.lang.Object value) throws java.sql.SQLException </code></pre><p>Deprecated.  Execute a query using a single column name/value pair as the routing information. Parameters:sql - The query to be routed.segCol - The column name.value - The column value. <strong>Returns</strong> the result set created by the routable query. Throws: java.sql.SQLException - Query not routable or has failed.</p> <h4 id="close">close</h4> <pre tabindex="0"><code>void close() throws java.sql.SQLException </code></pre><p>Deprecated.  Release resource used by this VerticaRoutableExecutor - close the result set(s) Throws: java.sql.SQLException - close operation has failed.</p> <h4 id="getwarnings">getWarnings</h4> <pre tabindex="0"><code>java.sql.SQLWarning getWarnings() throws java.sql.SQLException </code></pre><p>Deprecated.  Get SQLWarning after an <a href="VGet.md#execute">VGet.execute()</a> call. See <a href="VGet.md#getWarnings">VGet.getWarnings()</a> <strong>Returns</strong> SQLWarning from execute call. Throws: java.sql.SQLException - attempt to get warning has failed.</p> /en/api-reference/jdbc-api/com/vertica/jdbc/verticastatement/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/com/vertica/jdbc/verticastatement/ <ul> <li>All Superinterfaces: java.lang.AutoCloseable, java.sql.Statement, java.sql.Wrapper</li> </ul> <pre tabindex="0"><code>public interface VerticaStatement extends java.sql.Statement </code></pre><p>This interface defines the public Vertica Analytic Database extensions to java.sql.Statement. All Statements constructed by the Vertica JDBC driver implement VerticaStatement.</p> <h3 id="field-summary">Field Summary</h3> <h3 id="fields-inherited-from-interfacejavasqlstatement">Fields inherited from interface java.sql.Statement</h3> <p>CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO</p> <h3 id="method-summary">Method Summary</h3> <h3 id="methods-inherited-from-interfacejavasqlstatement">Methods inherited from interface java.sql.Statement</h3> <p>addBatch, cancel, clearBatch, clearWarnings, close, closeOnCompletion, execute, execute, execute, execute, executeBatch, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout</p> <h3 id="methods-inherited-from-interfacejavasqlwrapper">Methods inherited from interface java.sql.Wrapper</h3> <p>isWrapperFor, unwrap</p> /en/api-reference/jdbc-api/com/vertica/jdbc/verticatypes/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/com/vertica/jdbc/verticatypes/ <ul> <li> <p>java.lang.Object</p> </li> <li> <p>com.vertica.jdbc.VerticaTypes</p> </li> </ul> <pre tabindex="0"><code>public class VerticaTypes extends java.lang.Object </code></pre><p>This class defines Vertica identifiers for data types Vertica supports but which are not represented in java.sql.types.</p> <p>These identifiers are used in metadata queries and to give Vertica JDBC applications a way to specify the types and determine how to correctly get or set their values.</p> <p>Interval type constants</p> <p>The JDBC specification does not define first class support for interval data types. There are no java.sql.Types type identifiers for intervals, there is no built in setter on the PreparedStatement interface and no built in getter on the ResultSet interface.</p> <p>Instead, the Vertica JDBC driver follows the ODBC standard when it can. Each of the 10 day/time interval ranges is identified by the ODBC standard SQL type identifier. Those identifiers are recreated as integer fields in this class, analogous to those defined for the other data types by java.sql.Types.</p> <p>UUID type constant</p> <p>The JDBC specification does not define a UUID type. The Vertica JDBC driver uses the ODBC type identifier for UUIDs.</p> <h3 id="field-summary">Field Summary</h3> <table> <thead> <tr> <th>Modifier and Type</th> <th>Field and Description</th> </tr> </thead> <tbody> <tr> <td>static int</td> <td>INTERVAL_DAY The ODBC SQL type identifier for an INTERVAL DAY interval.</td> </tr> <tr> <td>static int</td> <td>INTERVAL_DAY_TO_HOUR The ODBC SQL type identifier for an INTERVAL DAY TO HOUR interval.</td> </tr> <tr> <td>static int</td> <td>INTERVAL_DAY_TO_MINUTE The ODBC SQL type identifier for an INTERVAL DAY TO MINUTE interval.</td> </tr> <tr> <td>static int</td> <td>INTERVAL_DAY_TO_SECOND The ODBC SQL type identifier for an INTERVAL DAY TO SECOND interval.</td> </tr> <tr> <td>static int</td> <td>INTERVAL_HOUR The ODBC SQL type identifier for an INTERVAL HOUR interval.</td> </tr> <tr> <td>static int</td> <td>INTERVAL_HOUR_TO_MINUTE The ODBC SQL type identifier for an INTERVAL HOUR TO MINUTE interval.</td> </tr> <tr> <td>static int</td> <td>INTERVAL_HOUR_TO_SECOND The ODBC SQL type identifier for an INTERVAL HOUR TO SECOND interval.</td> </tr> <tr> <td>static int</td> <td>INTERVAL_MINUTE The ODBC SQL type identifier for an INTERVAL MINUTE interval.</td> </tr> <tr> <td>static int</td> <td>INTERVAL_MINUTE_TO_SECOND The ODBC SQL type identifier for an INTERVAL MINUTE TO SECOND interval.</td> </tr> <tr> <td>static int</td> <td>INTERVAL_MONTH The ODBC SQL type identifier for an INTERVAL MONTH interval.</td> </tr> <tr> <td>static int</td> <td>INTERVAL_SECOND The ODBC SQL type identifier for an INTERVAL SECOND interval.</td> </tr> <tr> <td>static int</td> <td>INTERVAL_YEAR The ODBC SQL type identifier for an INTERVAL YEAR interval.</td> </tr> <tr> <td>static int</td> <td>INTERVAL_YEAR_TO_MONTH The ODBC SQL type identifier for an INTERVAL YEAR TO MONTH interval.</td> </tr> <tr> <td>static int</td> <td>UUID The ODBC SQL type identifier for a UUID.</td> </tr> </tbody> </table> <h3 id="constructor-summary">Constructor Summary</h3> <table> <thead> <tr> <th>Constructor and Description</th> </tr> </thead> <tbody> <tr> <td>VerticaTypes()</td> </tr> </tbody> </table> <h3 id="method-summary">Method Summary</h3> <h3 id="methods-inherited-from-classjavalangobject">Methods inherited from class java.lang.Object</h3> <p>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</p> <h3 id="field-detail">Field Detail</h3> <h4 id="interval_day">INTERVAL_DAY</h4> <pre tabindex="0"><code>public static final int INTERVAL_DAY </code></pre><p>The ODBC SQL type identifier for an INTERVAL DAY interval. See Also:Constant Field Values</p> <h4 id="interval_day_to_hour">INTERVAL_DAY_TO_HOUR</h4> <pre tabindex="0"><code>public static final int INTERVAL_DAY_TO_HOUR </code></pre><p>The ODBC SQL type identifier for an INTERVAL DAY TO HOUR interval. See Also:Constant Field Values</p> <h4 id="interval_day_to_minute">INTERVAL_DAY_TO_MINUTE</h4> <pre tabindex="0"><code>public static final int INTERVAL_DAY_TO_MINUTE </code></pre><p>The ODBC SQL type identifier for an INTERVAL DAY TO MINUTE interval. See Also:Constant Field Values</p> <h4 id="interval_day_to_second">INTERVAL_DAY_TO_SECOND</h4> <pre tabindex="0"><code>public static final int INTERVAL_DAY_TO_SECOND </code></pre><p>The ODBC SQL type identifier for an INTERVAL DAY TO SECOND interval. See Also:Constant Field Values</p> <h4 id="interval_hour">INTERVAL_HOUR</h4> <pre tabindex="0"><code>public static final int INTERVAL_HOUR </code></pre><p>The ODBC SQL type identifier for an INTERVAL HOUR interval. See Also:Constant Field Values</p> <h4 id="interval_hour_to_minute">INTERVAL_HOUR_TO_MINUTE</h4> <pre tabindex="0"><code>public static final int INTERVAL_HOUR_TO_MINUTE </code></pre><p>The ODBC SQL type identifier for an INTERVAL HOUR TO MINUTE interval. See Also:Constant Field Values</p> <h4 id="interval_hour_to_second">INTERVAL_HOUR_TO_SECOND</h4> <pre tabindex="0"><code>public static final int INTERVAL_HOUR_TO_SECOND </code></pre><p>The ODBC SQL type identifier for an INTERVAL HOUR TO SECOND interval. See Also:Constant Field Values</p> <h4 id="interval_minute">INTERVAL_MINUTE</h4> <pre tabindex="0"><code>public static final int INTERVAL_MINUTE </code></pre><p>The ODBC SQL type identifier for an INTERVAL MINUTE interval. See Also:Constant Field Values</p> <h4 id="interval_minute_to_second">INTERVAL_MINUTE_TO_SECOND</h4> <pre tabindex="0"><code>public static final int INTERVAL_MINUTE_TO_SECOND </code></pre><p>The ODBC SQL type identifier for an INTERVAL MINUTE TO SECOND interval. See Also:Constant Field Values</p> <h4 id="interval_second">INTERVAL_SECOND</h4> <pre tabindex="0"><code>public static final int INTERVAL_SECOND </code></pre><p>The ODBC SQL type identifier for an INTERVAL SECOND interval. See Also:Constant Field Values</p> <h4 id="interval_year">INTERVAL_YEAR</h4> <pre tabindex="0"><code>public static final int INTERVAL_YEAR </code></pre><p>The ODBC SQL type identifier for an INTERVAL YEAR interval. See Also:Constant Field Values</p> <h4 id="interval_year_to_month">INTERVAL_YEAR_TO_MONTH</h4> <pre tabindex="0"><code>public static final int INTERVAL_YEAR_TO_MONTH </code></pre><p>The ODBC SQL type identifier for an INTERVAL YEAR TO MONTH interval. See Also:Constant Field Values</p> <h4 id="interval_month">INTERVAL_MONTH</h4> <pre tabindex="0"><code>public static final int INTERVAL_MONTH </code></pre><p>The ODBC SQL type identifier for an INTERVAL MONTH interval. See Also:Constant Field Values</p> <h4 id="uuid">UUID</h4> <pre tabindex="0"><code>public static final int UUID </code></pre><p>The ODBC SQL type identifier for a UUID. See Also:Constant Field Values</p> <h3 id="constructor-detail">Constructor Detail</h3> <h4 id="verticatypes">VerticaTypes</h4> <pre tabindex="0"><code>public VerticaTypes() </code></pre> /en/api-reference/jdbc-api/com/vertica/jdbc/verticayearmonthinterval/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/com/vertica/jdbc/verticayearmonthinterval/ <ul> <li> <p>java.lang.Object</p> </li> <li> <p>com.vertica.dsi.dataengine.utilities.DSIMonthSpan</p> </li> <li> <p>com.vertica.jdbc.VerticaYearMonthInterval</p> </li> <li> <p>All Implemented Interfaces: java.lang.Cloneable</p> </li> </ul> <pre tabindex="0"><code>public class VerticaYearMonthInterval extends com.vertica.dsi.dataengine.utilities.DSIMonthSpan implements java.lang.Cloneable </code></pre><p>The JDBC representation of the Vertica INTERVAL YEAR TO MONTH type. It represents a span of time measured in years and months.</p> <p>The JDBC specification does not define first class support for interval data types. There are no java.sql.Types type identifiers for intervals, there is no built in setter on the PreparedStatement interface and no built in getter on the ResultSet interface.</p> <p>Instead, the Vertica JDBC driver follows the ODBC standard when it can. Each of the 3 year/month interval ranges is identified by the ODBC standard SQL type identifier. Those identifiers are recreated as integer fields in this class, analogous to those defined for the other data types by java.sql.Types.</p> <p>To insert a year/month interval into the database, create an instance of this class and pass it to PreparedStatement.setObject, optionally passing one of the ODBC SQL types defined by this class as the target type parameter.</p> <p>To retrieve a VericaYearMonthInterval from the database, select an INTERVAL YEAR TO MONTH column, call ResultSet.getObject and cast the result to a VerticaYearMonthInterval</p> <h3 id="field-summary">Field Summary</h3> <table> <thead> <tr> <th>Modifier and Type</th> <th>Field and Description</th> </tr> </thead> <tbody> <tr> <td>static int</td> <td>INTERVAL_MONTH Deprecated. superseded by VerticaTypes.INTERVAL_MONTH</td> </tr> <tr> <td>static int</td> <td>INTERVAL_YEAR Deprecated. superseded by VerticaTypes.INTERVAL_YEAR</td> </tr> <tr> <td>static int</td> <td>INTERVAL_YEAR_TO_MONTH Deprecated. superseded by VerticaTypes.INTERVAL_YEAR_TO_MONTH</td> </tr> </tbody> </table> <h3 id="constructor-summary">Constructor Summary</h3> <table> <thead> <tr> <th>Constructor and Description</th> </tr> </thead> <tbody> <tr> <td>VerticaYearMonthInterval(int year, int month, boolean isNegative) Constructs a new VerticaYearMonthInterval.</td> </tr> <tr> <td>VerticaYearMonthInterval(int type, int year, int month, boolean isNegative) Constructs a new VerticaYearMonthInterval.</td> </tr> </tbody> </table> <h3 id="method-summary">Method Summary</h3> <table> <thead> <tr> <th>Modifier and Type</th> <th>Method and Description</th> </tr> </thead> <tbody> <tr> <td>VerticaYearMonthInterval</td> <td>clone() Returns a deep copy of this VerticaYearMonthInterval.</td> </tr> <tr> <td>boolean</td> <td>equals(java.lang.Object obj) Returns true if obj is a VerticaYearMonthInterval and it represents the same span of time as this interval, regardless of which units are set.</td> </tr> <tr> <td>int</td> <td>getIntervalType() Gets the ODBC SQL type identifier for this interval.</td> </tr> <tr> <td>int</td> <td>hashCode() The hash code of an interval is calculated first by converting this interval to a number of months.</td> </tr> <tr> <td>static boolean</td> <td>isYearMonthInterval(int type) A helper method to determine if the provided ODBC interval subtype identifier corresponds to one of the 3 year/month intervals that this class is capable of representing.</td> </tr> <tr> <td>void</td> <td>setMonth(int month) Sets the months component of this interval.</td> </tr> <tr> <td>void</td> <td>setYear(int year) Sets the years component of this interval.</td> </tr> <tr> <td>java.lang.String</td> <td>toString() Returns a string representation of this interval.</td> </tr> </tbody> </table> <h3 id="methods-inherited-from-classcomverticadsidataengineutilitiesdsimonthspan">Methods inherited from class com.vertica.dsi.dataengine.utilities.DSIMonthSpan</h3> <p>getMonth, getYear, isNegative, setIsNegative</p> <h3 id="methods-inherited-from-classjavalangobject">Methods inherited from class java.lang.Object</h3> <p>getClass, notify, notifyAll, wait, wait, wait</p> <h3 id="field-detail">Field Detail</h3> <h4 id="interval_year">INTERVAL_YEAR</h4> <pre tabindex="0"><code>public static final int INTERVAL_YEAR </code></pre><p>Deprecated. superseded by <a href="VerticaTypes.md#INTERVAL_YEAR">VerticaTypes.INTERVAL_YEAR</a> The ODBC SQL type identifier for an INTERVAL YEAR interval. See Also:Constant Field Values</p> <h4 id="interval_year_to_month">INTERVAL_YEAR_TO_MONTH</h4> <pre tabindex="0"><code>public static final int INTERVAL_YEAR_TO_MONTH </code></pre><p>Deprecated. superseded by <a href="VerticaTypes.md#INTERVAL_YEAR_TO_MONTH">VerticaTypes.INTERVAL_YEAR_TO_MONTH</a> The ODBC SQL type identifier for an INTERVAL YEAR TO MONTH interval. See Also:Constant Field Values</p> <h4 id="interval_month">INTERVAL_MONTH</h4> <pre tabindex="0"><code>public static final int INTERVAL_MONTH </code></pre><p>Deprecated. superseded by <a href="VerticaTypes.md#INTERVAL_MONTH">VerticaTypes.INTERVAL_MONTH</a> The ODBC SQL type identifier for an INTERVAL MONTH interval. See Also:Constant Field Values</p> <h3 id="constructor-detail">Constructor Detail</h3> <h4 id="verticayearmonthinterval">VerticaYearMonthInterval</h4> <pre tabindex="0"><code>public VerticaYearMonthInterval(int year, int month, boolean isNegative) </code></pre><p>Constructs a new VerticaYearMonthInterval. The type is assumed to be INTERVAL_YEAR_TO_MONTH. Parameters:year - The number of years in this interval. Must be no less than zero.month - The number of months in this interval. Must be no less than zero.isNegative - True if this interval is negative, false if positive. Throws: java.lang.IllegalArgumentException - If year or month are negative.</p> <h4 id="verticayearmonthinterval-1">VerticaYearMonthInterval</h4> <pre tabindex="0"><code>public VerticaYearMonthInterval(int type, int year, int month, boolean isNegative) </code></pre><p>Constructs a new VerticaYearMonthInterval. Parameters:type - The ODBC SQL type identifier for this interval.year - The number of years in this interval. Must be no less than zero.month - The number of months in this interval. Must be no less than zero.isNegative - True if this interval is negative, false if positive. Throws: java.lang.IllegalArgumentException - If year or month are negative, or if type is not one of the ODBC SQL type identifiers defined by this class.</p> <h3 id="method-detail">Method Detail</h3> <h4 id="setyear">setYear</h4> <pre tabindex="0"><code>public void setYear(int year) </code></pre><p>Sets the years component of this interval. If this interval has no year component, it will be converted to a number of months.</p> <p><strong>Overrides</strong> setYear in class com.vertica.dsi.dataengine.utilities.DSIMonthSpan Parameters:year - A positive number of years. Throws: java.lang.IllegalArgumentException - If year is negative, or if using this many years would cause the interval to overflow.</p> <h4 id="setmonth">setMonth</h4> <pre tabindex="0"><code>public void setMonth(int month) </code></pre><p>Sets the months component of this interval. If this interval has no month component, it will be converted to a number of years. Any fraction on the converted years value is rounded down.</p> <p><strong>Overrides</strong> setMonth in class com.vertica.dsi.dataengine.utilities.DSIMonthSpan Parameters:month - A positive number of months. Throws: java.lang.IllegalArgumentException - If month is negative, or if using this many months would cause the interval to overflow.</p> <h4 id="hashcode">hashCode</h4> <pre tabindex="0"><code>public int hashCode() </code></pre><p>The hash code of an interval is calculated first by converting this interval to a number of months. Since the hash code must fit in an integer, it is possible that this calculation will overflow. Regardless of whether or not there was overflow, this number is then multiplied by -1 if this interval negative.</p> <p><strong>Overrides</strong> hashCode in class com.vertica.dsi.dataengine.utilities.DSIMonthSpan <strong>Returns</strong> A hash code for this interval.</p> <h4 id="equals">equals</h4> <pre tabindex="0"><code>public boolean equals(java.lang.Object obj) </code></pre><p>Returns true if obj is a VerticaYearMonthInterval and it represents the same span of time as this interval, regardless of which units are set. For example, a SQL INTERVAL YEAR of 1 year is equal to an INTERVAL YEAR TO MONTH of 1 year, 0 months, and an INTERVAL MONTH of 12 months.</p> <p><strong>Overrides</strong> equals in class com.vertica.dsi.dataengine.utilities.DSIMonthSpan Parameters:obj - An object to compare. <strong>Returns</strong> true if obj represents the same span of time as this interval.</p> <h4 id="clone">clone</h4> <pre tabindex="0"><code>public VerticaYearMonthInterval clone() </code></pre><p>Returns a deep copy of this VerticaYearMonthInterval. Equivalent to calling new VerticaYearMonthInterval(getIntervalType(), getYear(), getMonth(), isNegative())</p> <p><strong>Overrides</strong> clone in class com.vertica.dsi.dataengine.utilities.DSIMonthSpan <strong>Returns</strong> A copy of this interval.</p> <h4 id="tostring">toString</h4> <pre tabindex="0"><code>public java.lang.String toString() </code></pre><p>Returns a string representation of this interval. The format of this string is the same format that is recognized by the driver and database. Fields smaller than this interval's range (as defined by the ODBC type identifier) are not included in the String.</p> <p><strong>Overrides</strong> toString in class com.vertica.dsi.dataengine.utilities.DSIMonthSpan <strong>Returns</strong> The string representation of this interval.</p> <h4 id="getintervaltype">getIntervalType</h4> <pre tabindex="0"><code>public int getIntervalType() </code></pre><p>Gets the ODBC SQL type identifier for this interval. An interval's range can be determined by comparing the return value of this method with the INTERVAL_* constants defined in this class.</p> <p><strong>Overrides</strong> getIntervalType in class com.vertica.dsi.dataengine.utilities.DSIMonthSpan <strong>Returns</strong> The ODBC SQL type identifier for this interval.</p> <h4 id="isyearmonthinterval">isYearMonthInterval</h4> <pre tabindex="0"><code>public static boolean isYearMonthInterval(int type) </code></pre><p>A helper method to determine if the provided ODBC interval subtype identifier corresponds to one of the 3 year/month intervals that this class is capable of representing.</p> <p>The SQL_DATETIME_SUB column of the ResultSet returned by DatabaseMetaData.getColumns() will contain an ODBC interval subtype when the column is an interval. When this happens, the object returned by the driver when selecting that column will be a VerticaYearMonthInterval when the subtype is one of the 3 interval subtypes defined in this class. This helper method checks the provided type to see if it matches one of those 3 types. Parameters:type - An ODBC interval subtype identifier. <strong>Returns</strong> true If type corresponds to one of the 3 year/month interval types representable by a VerticaYearMonthInterval.</p> /en/api-reference/jdbc-api/com/vertica/jdbc/kv/vget/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/com/vertica/jdbc/kv/vget/ <ul> <li>Deprecated.  This feature is likely to stop working in a future release and to be removed as a result.</li> </ul> <pre tabindex="0"><code>@Deprecated public interface VGet </code></pre><p>A scalable key-based accessor for table data. The VGet directly queries Vertica nodes that have the data needed for the query, avoiding the distributed planning and execution costs associated with a normal execution. For workloads that access single rows based on a primary key, the VGet can be used to achieve lower latency and higher throughput than a traditional execution.</p> <p>The VGet uses projection segmentation metadata and a set of equality predicates on table columns to determine an appropriate projection and node to send a query to.</p> <p>The <a href="VGet.md#addPredicate">addPredicate(String, Object)</a> method is used to specify equality predicates on table columns. The VGet uses these predicates to evaluate the segmentation expression on the client to determine which node to query. At a minimum, the predicates columns passed must cover the segmentation expression of at least one of the table's underlying projections.</p> <p>Call the <a href="VGet.md#execute">execute()</a> method to run query. By default, the VGet fetches all the columns of all the rows that satisfy the logical AND of all the equality predicates passed via <a href="VGet.md#addPredicate">addPredicate(String, Object)</a>. To further customize the get operation, the <a href="VGet.md#addOutputColumn">addOutputColumn(String)</a>, <a href="VGet.md#addOutputExpression">addOutputExpression(String)</a> <a href="VGet.md#addPredicateExpression">addPredicateExpression(String)</a>, <a href="VGet.md#addSortColumn">addSortColumn(String, SortOrder)</a> and <a href="VGet.md#setLimit">setLimit(int)</a> may be used.</p> <p><a href="VGet.md#addOutputExpression">addOutputExpression(String)</a> and <a href="VGet.md#addPredicateExpression">addPredicateExpression(String)</a> accept arbitrary SQL expressions that operate on the table's columns as input. Care must be taken to ensure that the columns exist on the table and projection used by the VGet, and that the expressions do not require distributed resources to execute. If an expression is sufficiently complex as to require more than one node to execute, <a href="VGet.md#execute">execute()</a> will throw a SQLException if the FailOnMultiNodePlans connection property is true.</p> <p>Internally, VGet operations span multiple JDBC connections (and multiple Vertica sessions) and therefore do not honor the parent connection's transaction semantics. If consistency is required across multiple executions, the parent <a href="VerticaRoutableConnection.md">VerticaRoutableConnection</a>'s consistent read API can be used to guarantee all operations occur at the same epoch.</p> <p>The VGet is thread safe, but all methods are synchronized, so threads that share a VGet instance will never run in parallel. For better parallelism, each thread should have its own VGet instance. All VGet instances created by the same <a href="VerticaRoutableConnection.md">VerticaRoutableConnection</a> share pooled connections and metadata in a manner that enables a high degree of parallelism.</p> <h3 id="nested-class-summary">Nested Class Summary</h3> <table> <thead> <tr> <th>Modifier and Type</th> <th>Interface and Description</th> </tr> </thead> <tbody> <tr> <td>static class</td> <td>VGet.SortOrder Deprecated. Describes the ordering of result data.</td> </tr> </tbody> </table> <h3 id="method-summary">Method Summary</h3> <table> <thead> <tr> <th>Modifier and Type</th> <th>Method and Description</th> </tr> </thead> <tbody> <tr> <td>void</td> <td>addOutputColumn(java.lang.String outputCol) Deprecated. Adds an output column to the ResultSet returned by execute().</td> </tr> <tr> <td>void</td> <td>addOutputExpression(java.lang.String outputExpr) Deprecated. Adds the result of a free-form SQL expression to the ResultSet returned by execute().</td> </tr> <tr> <td>void</td> <td>addPredicate(java.lang.String column, java.lang.Object value) Deprecated. Adds or updates a column equality predicate.</td> </tr> <tr> <td>void</td> <td>addPredicateExpression(java.lang.String expr) Deprecated. Adds a free-form SQL predicate to filter results.</td> </tr> <tr> <td>void</td> <td>addSortColumn(java.lang.String column, VGet.SortOrder order) Deprecated. Adds the specified column to the sort order of the result.</td> </tr> <tr> <td>void</td> <td>clearOutputs() Deprecated. Clears out all outputs added with addOutputColumn(String) and addOutputExpression(String).</td> </tr> <tr> <td>void</td> <td>clearPredicates() Deprecated. Clears out all predicates added with addPredicate(String, Object) and addPredicateExpression(String).</td> </tr> <tr> <td>void</td> <td>clearSortColumns() Deprecated. Clears out all columns added to the sort by addSortColumn(String, SortOrder)</td> </tr> <tr> <td>void</td> <td>close() Deprecated. Releases resources used by this VGet.</td> </tr> <tr> <td>java.sql.ResultSet</td> <td>execute() Deprecated. Fetches the desired results.</td> </tr> <tr> <td>java.sql.SQLWarning</td> <td>getWarnings() Deprecated. Retrieves the first warning reported by calls on this VGet.</td> </tr> <tr> <td>void</td> <td>setLimit(int limit) Deprecated. Imposes a limit on the number of rows returned by execute().</td> </tr> </tbody> </table> <h3 id="method-detail">Method Detail</h3> <h4 id="addpredicate">addPredicate</h4> <pre tabindex="0"><code>void addPredicate(java.lang.String column, java.lang.Object value) throws java.sql.SQLException </code></pre><p>Deprecated.  Adds or updates a column equality predicate.</p> <p>Before execution, this method must be called for all columns of the segmentation key. Additional predicates on non-key columns are also allowed. Parameters:column - The name of a column.value - The value of the column. Pass null to indicate a SQL NULL. Throws: java.sql.SQLException - If the column does not exist or the value is not compatible with the data type of the column.</p> <h4 id="addpredicateexpression">addPredicateExpression</h4> <pre tabindex="0"><code>void addPredicateExpression(java.lang.String expr) throws java.sql.SQLException </code></pre><p>Deprecated.  Adds a free-form SQL predicate to filter results. Predicates can be on any column in the table. Segmentation key columns may be used, but must also be specified with <a href="VGet.md#addPredicate">addPredicate(String, Object)</a>.</p> <p>Currently the VGet does not check columns references in predicate expressions. Because they are not checked, the VGet can not ensure that they will exist on the projection chosen to answer the query. This can happen if a projection's column names do not match the anchor table's column names, or if the projection is not a superprojection. If this occurs, <a href="VGet.md#execute">execute()</a> will fail with a syntax error.</p> <p>To avoid this error, applications can override the VGet's projection choice by passing a projection name instead of a table name to <a href="VerticaRoutableConnection.md#prepareGet">VerticaRoutableConnection.prepareGet(String, String)</a></p> <p>Parameters:expr - A valid SQL expression acting on a column in the table. Incorrect syntax will cause <a href="VGet.md#execute">execute()</a> to fail. Throws: java.sql.SQLException - If this VGet is closed. In the future, may fail if the expression has invalid syntax.</p> <h4 id="clearpredicates">clearPredicates</h4> <pre tabindex="0"><code>void clearPredicates() </code></pre><p>Deprecated.  Clears out all predicates added with <a href="VGet.md#addPredicate">addPredicate(String, Object)</a> and <a href="VGet.md#addPredicateExpression">addPredicateExpression(String)</a>.</p> <h4 id="addsortcolumn">addSortColumn</h4> <pre tabindex="0"><code>void addSortColumn(java.lang.String column, VGet.SortOrder order) throws java.sql.SQLException </code></pre><p>Deprecated.  Adds the specified column to the sort order of the result. Parameters:column - The name of a column in the tableorder - The sort order for the column Throws: java.sql.SQLException - If this VGet is closed, or if the column does not exist on this table</p> <h4 id="clearsortcolumns">clearSortColumns</h4> <pre tabindex="0"><code>void clearSortColumns() </code></pre><p>Deprecated.  Clears out all columns added to the sort by <a href="VGet.md#addSortColumn">addSortColumn(String, SortOrder)</a></p> <h4 id="addoutputcolumn">addOutputColumn</h4> <pre tabindex="0"><code>void addOutputColumn(java.lang.String outputCol) throws java.sql.SQLException </code></pre><p>Deprecated.  Adds an output column to the ResultSet returned by <a href="VGet.md#execute">execute()</a>. If no output columns or expressions are specified, the entire row is returned. Parameters:outputCol - A column from the table. Throws: java.sql.SQLException - If the column does not exist on this table.</p> <h4 id="addoutputexpression">addOutputExpression</h4> <pre tabindex="0"><code>void addOutputExpression(java.lang.String outputExpr) throws java.sql.SQLException </code></pre><p>Deprecated.  Adds the result of a free-form SQL expression to the ResultSet returned by <a href="VGet.md#execute">execute()</a>. The expression can reference and perform computation on any columns in the table.</p> <p>If no output columns or expressions are specified, the entire row is returned.</p> <p>Currently the VGet does not check columns references in output expressions. Because they are not checked, the VGet can not ensure that they will exist on the projection chosen to answer the query. This can happen if a projection's column names do not match the anchor table's column names, or if the projection is not a superprojection. If this occurs, <a href="VGet.md#execute">execute()</a> will fail with a syntax error.</p> <p>To avoid this error, applications can override the VGet's projection choice by passing a projection name instead of a table name to <a href="VerticaRoutableConnection.md#prepareGet">VerticaRoutableConnection.prepareGet(String, String)</a></p> <p>Parameters:outputExpr - A valid SQL expression. Incorrect syntax will cause <a href="VGet.md#execute">execute()</a> to fail. Throws: java.sql.SQLException - If this VGet is closed. In the future, may fail if the expression has invalid syntax.</p> <h4 id="clearoutputs">clearOutputs</h4> <pre tabindex="0"><code>void clearOutputs() </code></pre><p>Deprecated.  Clears out all outputs added with <a href="VGet.md#addOutputColumn">addOutputColumn(String)</a> and <a href="VGet.md#addOutputExpression">addOutputExpression(String)</a>.</p> <h4 id="setlimit">setLimit</h4> <pre tabindex="0"><code>void setLimit(int limit) </code></pre><p>Deprecated.  Imposes a limit on the number of rows returned by <a href="VGet.md#execute">execute()</a>. The default value of zero indicates no limit. Parameters:limit - A maximum number of rows to return, or zero to indicate no limit.</p> <h4 id="execute">execute</h4> <pre tabindex="0"><code>java.sql.ResultSet execute() throws java.sql.SQLException </code></pre><p>Deprecated.  Fetches the desired results. Routes the request directly to the node containing the data. If the get operation requires a distributed execution (due to complex expressions specified by <a href="VGet.md#addOutputExpression">addOutputExpression(String)</a> or <a href="VGet.md#addPredicateExpression">addPredicateExpression(String)</a>) and FailOnMultiNodePlans is set to true, this will throw a SQLException. If FailOnMultiNodePlans is false, a warning is generated and returned by <a href="VGet.md#getWarnings">getWarnings()</a>. <strong>Returns</strong> A ResultSet iterator over the rows of data produced by the get operation. Throws: java.sql.SQLException - If not enough predicates were provided to determine the routing, or if a database error occurs.</p> <h4 id="close">close</h4> <pre tabindex="0"><code>void close() throws java.sql.SQLException </code></pre><p>Deprecated.  Releases resources used by this VGet. Throws: java.sql.SQLException - If close operation fails.</p> <h4 id="getwarnings">getWarnings</h4> <pre tabindex="0"><code>java.sql.SQLWarning getWarnings() throws java.sql.SQLException </code></pre><p>Deprecated.  Retrieves the first warning reported by calls on this VGet. Subsequent warnings will be chained to the SQLWarning returned.</p> <p>The warning chain is cleared with each call to <a href="VGet.md#execute">execute()</a>. <strong>Returns</strong> The first SQLWarning, or null if there are no warnings Throws: java.sql.SQLException - If attempt to get warning fails.</p> /en/api-reference/jdbc-api/com/vertica/jdbc/kv/vget.sortorder/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/com/vertica/jdbc/kv/vget.sortorder/ <ul> <li> <p>java.lang.Object</p> </li> <li> <p>java.lang.Enum</p> </li> <li> <p>com.vertica.jdbc.kv.VGet.SortOrder</p> </li> <li> <p>All Implemented Interfaces: java.io.Serializable, java.lang.Comparable</p> </li> </ul> <p>Enclosing interface: <a href="VGet.md">VGet</a></p> <pre tabindex="0"><code>public static enum VGet.SortOrder extends java.lang.Enum </code></pre><p>Describes the ordering of result data. Semantics for ordering are the same as Vertica's ORDER BY clause.</p> <h3 id="enum-constant-summary">Enum Constant Summary</h3> <table> <thead> <tr> <th>Enum Constant and Description</th> </tr> </thead> <tbody> <tr> <td>ASC</td> </tr> <tr> <td>DESC</td> </tr> </tbody> </table> <h3 id="method-summary">Method Summary</h3> <table> <thead> <tr> <th>Modifier and Type</th> <th>Method and Description</th> </tr> </thead> <tbody> <tr> <td>static VGet.SortOrder</td> <td>valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.</td> </tr> <tr> <td>static VGet.SortOrder[]</td> <td>values() Returns an array containing the constants of this enum type, in the order they are declared.</td> </tr> </tbody> </table> <h3 id="methods-inherited-from-classjavalangenum">Methods inherited from class java.lang.Enum</h3> <p>compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</p> <h3 id="methods-inherited-from-classjavalangobject">Methods inherited from class java.lang.Object</h3> <p>getClass, notify, notifyAll, wait, wait, wait</p> <h3 id="enum-constant-detail">Enum Constant Detail</h3> <h4 id="asc">ASC</h4> <pre tabindex="0"><code>public static final VGet.SortOrder ASC </code></pre><h4 id="desc">DESC</h4> <pre tabindex="0"><code>public static final VGet.SortOrder DESC </code></pre><h3 id="method-detail">Method Detail</h3> <h4 id="values">values</h4> <pre tabindex="0"><code>public static VGet.SortOrder[] values() </code></pre><p>Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:</p> <pre tabindex="0"><code>for (VGet.SortOrder c : VGet.SortOrder.values())   System.out.println(c); </code></pre><p><strong>Returns</strong> an array containing the constants of this enum type, in the order they are declared</p> <h4 id="valueof">valueOf</h4> <pre tabindex="0"><code>public static VGet.SortOrder valueOf(java.lang.String name) </code></pre><p>Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) Parameters:name - the name of the enum constant to be returned. <strong>Returns</strong> the enum constant with the specified name Throws: java.lang.IllegalArgumentException - if this enum type has no constant with the specified name java.lang.NullPointerException - if the argument is null</p> /en/api-reference/jdbc-api/com/vertica/jdbc/kv/vhash/ Mon, 01 Jan 0001 00:00:00 +0000 /en/api-reference/jdbc-api/com/vertica/jdbc/kv/vhash/ <ul> <li> <p>java.lang.Object</p> </li> <li> <p>com.vertica.jdbc.kv.VHash</p> </li> <li> <p>Deprecated.  This feature is likely to stop working in a future release and to be removed as a result.</p> </li> </ul> <pre tabindex="0"><code>@Deprecated public class VHash extends java.lang.Object </code></pre><p>Implementation of Vertica's hash function used for data segmentation on the cluster. For single-value hashing, use static methods. For multi-value hashing, instantiate the class and call the add methods to add each value (order matters).</p> <h3 id="constructor-summary">Constructor Summary</h3> <table> <thead> <tr> <th>Constructor and Description</th> </tr> </thead> <tbody> <tr> <td>VHash() Deprecated. Creates an instance suitable for computing a hash of a chain of values, for use when a projection is segmented by multiple columns.</td> </tr> </tbody> </table> <h3 id="method-summary">Method Summary</h3> <table> <thead> <tr> <th>Modifier and Type</th> <th>Method and Description</th> </tr> </thead> <tbody> <tr> <td>void</td> <td>addBoolean(boolean v) Deprecated. adds hash of boolean value to the chain.</td> </tr> <tr> <td>void</td> <td>addBooleanNull() Deprecated. adds hash of boolean null value to the chain.</td> </tr> <tr> <td>void</td> <td>addBytes(byte[] v) Deprecated. adds hash of binary value to the chain.</td> </tr> <tr> <td>void</td> <td>addDate(java.util.Date v, java.util.Calendar c) Deprecated. adds hash of Date value to the chain.</td> </tr> <tr> <td>void</td> <td>addDate(java.sql.Date v, java.util.Calendar c) Deprecated. adds hash of Date value to the chain.</td> </tr> <tr> <td>void</td> <td>addDouble(double v) Deprecated. adds hash of double value to the chain.</td> </tr> <tr> <td>void</td> <td>addDoubleNull() Deprecated. adds hash of double null value to the chain.</td> </tr> <tr> <td>void</td> <td>addLong(long v) Deprecated. adds hash of long value to the chain.</td> </tr> <tr> <td>void</td> <td>addNull() Deprecated. Adds hash of null value to the chain.</td> </tr> <tr> <td>void</td> <td>addNumeric(java.math.BigDecimal src, int typemod) Deprecated. adds hash of numeric value to the chain</td> </tr> <tr> <td>void</td> <td>addString(java.lang.String v) Deprecated. adds hash of String value to the chain.</td> </tr> <tr> <td>void</td> <td>addTime(java.util.Date v, java.util.Calendar c) Deprecated. adds hash of Time value to the chain.</td> </tr> <tr> <td>void</td> <td>addTime(java.sql.Time v, java.util.Calendar c) Deprecated. adds hash of Time value to the chain.</td> </tr> <tr> <td>void</td> <td>addTimestamp(java.util.Date v, java.util.Calendar c) Deprecated. adds hash of Timestamp value to the chain.</td> </tr> <tr> <td>void</td> <td>addTimestamp(long v) Deprecated. adds hash of Timestamp value expressed as milliseconds since Jan 1, 1970 UTC to the chain.</td> </tr> <tr> <td>void</td> <td>addTimestamp(java.sql.Timestamp v, java.util.Calendar c) Deprecated. adds hash of Timestamp value to the chain.</td> </tr> <tr> <td>void</td> <td>addUUID(java.util.UUID v) Deprecated. adds hash of UUID value to the chain.</td> </tr> <tr> <td>void</td> <td>addUUIDNull() Deprecated. adds hash of null UUID to the chain.</td> </tr> <tr> <td>long</td> <td>getHash() Deprecated. returns the current hash value</td> </tr> <tr> <td>static java.lang.String</td> <td>getNodeFor(java.sql.Connection conn, java.lang.String schema, java.lang.String proj, long hashValue) Deprecated. Returns the name of the node that will be responsible for the provided value in the hash space for a given projection.</td> </tr> <tr> <td>static java.lang.String</td> <td>getNodeFor(java.lang.String getProjSegmentsOutput, long hashValue) Deprecated. Given a projection's get_projection_segments() output, this method will return the node that is responsible for the provided hashValue.</td> </tr> <tr> <td>static long</td> <td>hashBoolean(boolean v) Deprecated. compute hash of boolean value</td> </tr> <tr> <td>static long</td> <td>hashBooleanNull() Deprecated. compute hash of boolean null value</td> </tr> <tr> <td>static long</td> <td>hashBytes(byte[] b) Deprecated. compute hash of a binary value</td> </tr> <tr> <td>static long</td> <td>hashBytesNull() Deprecated. compute hash of a binary null value</td> </tr> <tr> <td>static long</td> <td>hashBytesNull(long input) Deprecated. compute hash of a binary null value</td> </tr> <tr> <td>static long</td> <td>hashDate(java.util.Date v) Deprecated. compute hash of java.util.Date value</td> </tr> <tr> <td>static long</td> <td>hashDate(java.sql.Date v) Deprecated. compute hash of java.sql.Date value</td> </tr> <tr> <td>static long</td> <td>hashDouble(double v) Deprecated. compute hash of double value</td> </tr> <tr> <td>static long</td> <td>hashDoubleNull() Deprecated. compute hash of double null value</td> </tr> <tr> <td>static long</td> <td>hashLong(long v) Deprecated. compute hash of long value</td> </tr> <tr> <td>static long</td> <td>hashNull() Deprecated. Compute hash of null value</td> </tr> <tr> <td>static long</td> <td>hashNull(long input) Deprecated. compute hash of null value.</td> </tr> <tr> <td>static long</td> <td>hashNumeric(java.math.BigDecimal src, int typemod) Deprecated. compute hash of a numeric value</td> </tr> <tr> <td>static long</td> <td>hashString(java.lang.String s) Deprecated. compute hash of String value</td> </tr> <tr> <td>static long</td> <td>hashStringNull() Deprecated. compute hash of String null value</td> </tr> <tr> <td>static long</td> <td>hashTime(java.sql.Time v) Deprecated. compute hash of Time value</td> </tr> <tr> <td>static long</td> <td>hashTimestamp(long java_ms) Deprecated. compute hash of Timestamp value expressed in milliseconds since Jan 1, 1970.</td> </tr> <tr> <td>static long</td> <td>hashTimestamp(java.sql.Timestamp v) Deprecated. compute hash of java.sql.Timestamp value</td> </tr> <tr> <td>static long</td> <td>hashUUID(java.util.UUID v, long input) Deprecated. compute hash of UUID value.</td> </tr> <tr> <td>static long</td> <td>hashUUIDNull() Deprecated. compute a hash of a null UUID value.</td> </tr> <tr> <td>static long</td> <td>hashUUIDNull(long input) Deprecated. compute a hash of a null UUID value.</td> </tr> <tr> <td>void</td> <td>reset() Deprecated. resets hash value for next chain.</td> </tr> </tbody> </table> <h3 id="methods-inherited-from-classjavalangobject">Methods inherited from class java.lang.Object</h3> <p>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</p> <h3 id="constructor-detail">Constructor Detail</h3> <h4 id="vhash">VHash</h4> <pre tabindex="0"><code>public VHash() </code></pre><p>Deprecated.  Creates an instance suitable for computing a hash of a chain of values, for use when a projection is segmented by multiple columns.</p> <h3 id="method-detail">Method Detail</h3> <h4 id="hashbooleannull">hashBooleanNull</h4> <pre tabindex="0"><code>public static long hashBooleanNull() </code></pre><p>Deprecated.  compute hash of boolean null value <strong>Returns</strong> long hash value</p> <h4 id="hashboolean">hashBoolean</h4> <pre tabindex="0"><code>public static long hashBoolean(boolean v) </code></pre><p>Deprecated.  compute hash of boolean value Parameters:v - boolean value to hash <strong>Returns</strong> long hash value</p> <h4 id="hashlong">hashLong</h4> <pre tabindex="0"><code>public static long hashLong(long v) </code></pre><p>Deprecated.  compute hash of long value Parameters:v - long value to hash <strong>Returns</strong> long hash value</p> <h4 id="hashnull">hashNull</h4> <pre tabindex="0"><code>public static long hashNull(long input) </code></pre><p>Deprecated.  compute hash of null value. First argument used to hash a list of values. Parameters:input - long value from previous hash function output <strong>Returns</strong> long hash value</p> <h4 id="hashnull-1">hashNull</h4> <pre tabindex="0"><code>public static long hashNull() </code></pre><p>Deprecated.  Compute hash of null value <strong>Returns</strong> long hash value</p> <h4 id="hashuuid">hashUUID</h4> <pre tabindex="0"><code>public static long hashUUID(java.util.UUID v, long input) </code></pre><p>Deprecated.  compute hash of UUID value. Parameters:v - fixed binary value to hashinput - variable input value to hash <strong>Returns</strong> long hash value</p> <h4 id="hashuuidnull">hashUUIDNull</h4> <pre tabindex="0"><code>public static long hashUUIDNull(long input) </code></pre><p>Deprecated.  compute a hash of a null UUID value. First argument used to hash a list of values. Parameters:input - long value from previous hash function output <strong>Returns</strong> The hash for null UUID.</p> <h4 id="hashuuidnull-1">hashUUIDNull</h4> <pre tabindex="0"><code>public static long hashUUIDNull() </code></pre><p>Deprecated.  compute a hash of a null UUID value. <strong>Returns</strong> The hash for null UUID.</p> <h4 id="hashdouble">hashDouble</h4> <pre tabindex="0"><code>public static long hashDouble(double v) </code></pre><p>Deprecated.  compute hash of double value Parameters:v - double value to hash <strong>Returns</strong> long hash value</p> <h4 id="hashdoublenull">hashDoubleNull</h4> <pre tabindex="0"><code>public static long hashDoubleNull() </code></pre><p>Deprecated.  compute hash of double null value <strong>Returns</strong> long hash value</p> <h4 id="hashtimestamp">hashTimestamp</h4> <pre tabindex="0"><code>public static long hashTimestamp(long java_ms) </code></pre><p>Deprecated.  compute hash of Timestamp value expressed in milliseconds since Jan 1, 1970. Parameters:java_ms - A number of milliseconds since Jan 1, 1970 GMT <strong>Returns</strong> long hash value</p> <h4 id="hashdate">hashDate</h4> <pre tabindex="0"><code>public static long hashDate(java.util.Date v) </code></pre><p>Deprecated.  compute hash of java.util.Date value Parameters:v - Date value to hash <strong>Returns</strong> long hash value</p> <h4 id="hashdate-1">hashDate</h4> <pre tabindex="0"><code>public static long hashDate(java.sql.Date v) </code></pre><p>Deprecated.  compute hash of java.sql.Date value Parameters:v - Date value to hash <strong>Returns</strong> long hash value</p> <h4 id="hashtimestamp-1">hashTimestamp</h4> <pre tabindex="0"><code>public static long hashTimestamp(java.sql.Timestamp v) </code></pre><p>Deprecated.  compute hash of java.sql.Timestamp value Parameters:v - Timestamp value to hash <strong>Returns</strong> long hash value</p> <h4 id="hashtime">hashTime</h4> <pre tabindex="0"><code>public static long hashTime(java.sql.Time v) </code></pre><p>Deprecated.  compute hash of Time value Parameters:v - Time value to hash <strong>Returns</strong> long hash value</p> <h4 id="hashstring">hashString</h4> <pre tabindex="0"><code>public static long hashString(java.lang.String s) </code></pre><p>Deprecated.  compute hash of String value Parameters:s - String value to hash <strong>Returns</strong> long hash value</p> <h4 id="hashstringnull">hashStringNull</h4> <pre tabindex="0"><code>public static long hashStringNull() </code></pre><p>Deprecated.  compute hash of String null value <strong>Returns</strong> long hash value</p> <h4 id="hashbytesnull">hashBytesNull</h4> <pre tabindex="0"><code>public static long hashBytesNull() </code></pre><p>Deprecated.  compute hash of a binary null value <strong>Returns</strong> long hash value</p> <h4 id="hashbytesnull-1">hashBytesNull</h4> <pre tabindex="0"><code>public static long hashBytesNull(long input) </code></pre><p>Deprecated.  compute hash of a binary null value Parameters:input - long value from previous hash function output <strong>Returns</strong> long hash value</p> <h4 id="hashbytes">hashBytes</h4> <pre tabindex="0"><code>public static long hashBytes(byte[] b) </code></pre><p>Deprecated.  compute hash of a binary value Parameters:b - binary value to hash <strong>Returns</strong> long hash value</p> <h4 id="hashnumeric">hashNumeric</h4> <pre tabindex="0"><code>public static long hashNumeric(java.math.BigDecimal src, int typemod) </code></pre><p>Deprecated.  compute hash of a numeric value Parameters:src - Numeric value to hashtypemod - The precision and scale of the numeric. <strong>Returns</strong> long hash value</p> <h4 id="reset">reset</h4> <pre tabindex="0"><code>public void reset() </code></pre><p>Deprecated.  resets hash value for next chain.</p> <h4 id="addnull">addNull</h4> <pre tabindex="0"><code>public void addNull() </code></pre><p>Deprecated.  Adds hash of null value to the chain. Use <a href="VHash.md#hashBooleanNull">hashBooleanNull()</a> to hash a boolean null.</p> <h4 id="addboolean">addBoolean</h4> <pre tabindex="0"><code>public void addBoolean(boolean v) </code></pre><p>Deprecated.  adds hash of boolean value to the chain. Parameters:v - boolean value to hash</p> <h4 id="addbooleannull">addBooleanNull</h4> <pre tabindex="0"><code>public void addBooleanNull() </code></pre><p>Deprecated.  adds hash of boolean null value to the chain.</p> <h4 id="addlong">addLong</h4> <pre tabindex="0"><code>public void addLong(long v) </code></pre><p>Deprecated.  adds hash of long value to the chain. Parameters:v - long value to hash</p> <h4 id="adduuid">addUUID</h4> <pre tabindex="0"><code>public void addUUID(java.util.UUID v) </code></pre><p>Deprecated.  adds hash of UUID value to the chain. Parameters:v - fixed binary value to hash</p> <h4 id="adduuidnull">addUUIDNull</h4> <pre tabindex="0"><code>public void addUUIDNull() </code></pre><p>Deprecated.  adds hash of null UUID to the chain.</p> <h4 id="addstring">addString</h4> <pre tabindex="0"><code>public void addString(java.lang.String v) </code></pre><p>Deprecated.  adds hash of String value to the chain. Parameters:v - String value to hash</p> <h4 id="addbytes">addBytes</h4> <pre tabindex="0"><code>public void addBytes(byte[] v) </code></pre><p>Deprecated.  adds hash of binary value to the chain. Parameters:v - String value to hash</p> <h4 id="addtimestamp">addTimestamp</h4> <pre tabindex="0"><code>public void addTimestamp(long v) </code></pre><p>Deprecated.  adds hash of Timestamp value expressed as milliseconds since Jan 1, 1970 UTC to the chain. Parameters:v - long value to hash</p> <h4 id="adddate">addDate</h4> <pre tabindex="0"><code>public void addDate(java.util.Date v, java.util.Calendar c) </code></pre><p>Deprecated.  adds hash of Date value to the chain. Parameters:v - Date value to hashc - The calendar to providing a timezone context for v.</p> <h4 id="adddate-1">addDate</h4> <pre tabindex="0"><code>public void addDate(java.sql.Date v, java.util.Calendar c) </code></pre><p>Deprecated.  adds hash of Date value to the chain. Parameters:v - Date value to hash.c - The calendar to providing a timezone context for v.</p> <h4 id="addtimestamp-1">addTimestamp</h4> <pre tabindex="0"><code>public void addTimestamp(java.sql.Timestamp v, java.util.Calendar c) </code></pre><p>Deprecated.  adds hash of Timestamp value to the chain. Parameters:v - Timestamp value to hashc - The calendar to providing a timezone context for v.</p> <h4 id="addtimestamp-2">addTimestamp</h4> <pre tabindex="0"><code>public void addTimestamp(java.util.Date v, java.util.Calendar c) </code></pre><p>Deprecated.  adds hash of Timestamp value to the chain. Parameters:v - Timestamp value to hashc - The calendar to providing a timezone context for v.</p> <h4 id="addtime">addTime</h4> <pre tabindex="0"><code>public void addTime(java.sql.Time v, java.util.Calendar c) </code></pre><p>Deprecated.  adds hash of Time value to the chain. Parameters:v - Time value to hashc - The calendar to providing a timezone context for v. The date component of the calendar will influence the time due to DST.</p> <h4 id="addtime-1">addTime</h4> <pre tabindex="0"><code>public void addTime(java.util.Date v, java.util.Calendar c) </code></pre><p>Deprecated.  adds hash of Time value to the chain. Parameters:v - Time value to hashc - The calendar to providing a timezone context for v. The date component of the calendar will influence the time due to DST.</p> <h4 id="adddouble">addDouble</h4> <pre tabindex="0"><code>public void addDouble(double v) </code></pre><p>Deprecated.  adds hash of double value to the chain. Parameters:v - double value to hash</p> <h4 id="adddoublenull">addDoubleNull</h4> <pre tabindex="0"><code>public void addDoubleNull() </code></pre><p>Deprecated.  adds hash of double null value to the chain.</p> <h4 id="addnumeric">addNumeric</h4> <pre tabindex="0"><code>public void addNumeric(java.math.BigDecimal src, int typemod) </code></pre><p>Deprecated.  adds hash of numeric value to the chain Parameters:src - The numeric value to add to hash.typemod - The precision and scale of the numeric. Throws: java.lang.IllegalArgumentException - if src is too large to fit in a numeric.</p> <h4 id="gethash">getHash</h4> <pre tabindex="0"><code>public long getHash() </code></pre><p>Deprecated.  returns the current hash value <strong>Returns</strong> long value of hash</p> <h4 id="getnodefor">getNodeFor</h4> <pre tabindex="0"><code>public static java.lang.String getNodeFor(java.sql.Connection conn, java.lang.String schema, java.lang.String proj, long hashValue) throws java.sql.SQLException </code></pre><p>Deprecated.  Returns the name of the node that will be responsible for the provided value in the hash space for a given projection.</p> <p>This method uses the provided Connection to call the get_projection_segments() SQL meta-function. It then relies on <a href="VHash.md#getNodeFor">getNodeFor(String, long)</a> to determine which node to use.</p> <p>In situations where you need to compute many hashes for the same projection, it is would be much more efficient to call get_projection_segments() once via JDBC and then pass that output to <a href="VHash.md#getNodeFor">getNodeFor(String, long)</a> directly.</p> <p>Caution: There is no guarantee that connecting to the node returned by this method will guarantee reduced intra-node traffic for a query or load based on the input hash value. While that is often true, the Vertica Optmizer may not always construct such a plan.</p> <p>Additionally, no check is done to ensure that the input hash value was created in a manner that is consistent with the segmentation of the provided projection. This means, for example, if the projection is segmented by an INTEGER column and the caller provides a hashed DOUBLE PRECISION value, the answer may not be correct. Parameters:conn - A connection to a vertica database containing the projectionschema - The schema of the projectionproj - The name of the projectionhashValue - A hashed data value for this projection <strong>Returns</strong> The name of the node that is responsible for the provided hash value Throws: java.sql.SQLException - If a database error occurs java.lang.IllegalArgumentException - if the projection provided is not segmented by HASH(...) ALL NODES</p> <h4 id="getnodefor-1">getNodeFor</h4> <pre tabindex="0"><code>public static java.lang.String getNodeFor(java.lang.String getProjSegmentsOutput, long hashValue) </code></pre><p>Deprecated.  Given a projection's get_projection_segments() output, this method will return the node that is responsible for the provided hashValue.</p> <p>The get_projection_segments() SQL meta-function returns a list of the segment ranges each node is responsible for for a given projection. This method parses the output of that function and maps the provided hashValue to the range to determine a node name.</p> <p>Caution: There is no guarantee that connecting to the node returned by this method will guarantee reduced intra-node traffic for a query or load based on the input hash value. While that is often true, the Vertica Optmizer may not always construct such a plan.</p> <p>Additionally, no check is done to ensure that the input hash value was created in a manner that is consistent with the segmentation of the provided projection. This means, for example, if the projection is segmented by an INTEGER column and the caller provides a hashed DOUBLE PRECISION value, the answer may not be correct. Parameters:getProjSegmentsOutput - -- a String containing the return value of the get_projection_segments() SQL meta-function for a particular projection.hashValue - -- a hashed data value for the projection. <strong>Returns</strong> string identifying node. Throws: java.lang.IllegalArgumentException - if getProjSegmentsOutput is malformed in any way, either due to bad input or due to not using a properly segmented projection.</p>