XDMPConnection

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.marklogic.xdmp
Class XDMPConnection

java.lang.Object
  com.marklogic.xdmp.XDMPConnection

All Implemented Interfaces:: XDBCConnection

public class XDMPConnection
extends Object
implements XDBCConnection

A connection (session) with a specific contentbase and port. Within the context of an XDBCConnection, XQuery statements are executed and results are returned.

An XDBCConnection's contentbase will provide information describing its XQuery compliance level and the capabilities of the connection with the 'getMetaData' method.

An XDMPConnection is threadsafe. It represents a socket, and each socket is pooled and assigned an XDMPConnection whenever it executes a query. Therefore, it is OK to share database connections across threads.

Field Summary

Fields inherited from interface com.marklogic.xdbc.XDBCConnection

XDBC_TRANSACTION_NONE, XDBC_TRANSACTION_READ_COMMITTED, XDBC_TRANSACTION_READ_UNCOMMITTED, XDBC_TRANSACTION_REPEATABLE_READ, XDBC_TRANSACTION_SERIALIZABLE

Constructor Summary
`XDMPConnection(String host, int port)` Constructor for XDMPConnection object.
`XDMPConnection(String host, int port, String prompt)` Constructor for XDMPConnection object.
`XDMPConnection(String host, int port, String user, String password)` Constructor for XDMPConnection object.

Method Summary
`void`	`clearWarnings()` Clears all warnings reported for this XDBCConnection object.
`void`	`close()` Releases a XDBCConnection's database and XDBC resources immediately instead of waiting for them to be automatically released.
`void`	`commit()` NOTE: This method is NOT currently supported.
`XDBCStatement`	`createStatement()` Creates a Statement object for sending XQuery expressions to the database.
`protected void`	`finalize()` Finalizer for XDMPConnection.
`boolean`	`getAutoCommit()` Gets the current auto-commit state of this connection.
`String`	`getHost()` Gets the host associated with this connection.
`Locale`	`getLocale()` Gets the locale associated with this database connection.
`static int`	`getMaxOpenDocInsertStreams()` Returns the maximum allowable number of open doc insert stream objects at any one time.
`static int`	`getMaxOpenResultSequences()` Returns the maximum allowable number of open result sequence objects at any one time
`XDBCDatabaseMetaData`	`getMetaData()` Gets the metadata regarding this connection's database.
`int`	`getPort()` Gets the port number of this connection.
`TimeZone`	`getTimeZone()` Gets the timezone associated with this database connection.
`int`	`getTransactionIsolation()` Return the database's default transaction isolation level.
`XDBCWarning`	`getWarnings()` Returns the first warning reported by calls on this XDMPConnection.
`boolean`	`isClosed()` Tests if this XDBCConnection is closed.
`boolean`	`isReadOnly()` Tests if this XDBCConnection is in read-only mode.
`XDMPDocInsertStream`	`openDocInsertStream()` Opens a document insert stream to insert multiple documents in the database in a single transaction.
`XDMPDocInsertStream`	`openDocInsertStream(String uri)` Opens a document insert stream to insert a document in the database.
`XDMPDocInsertStream`	`openDocInsertStream(String uri, Locale locale)` Deprecated. As of XDBC 3.0, replaced by `XDMPDocOptions`
`XDMPDocInsertStream`	`openDocInsertStream(String uri, Locale locale, boolean resolveEntities)` Deprecated. As of XDBC 3.0, replaced by `XDMPDocOptions`
`XDMPDocInsertStream`	`openDocInsertStream(String uri, Locale locale, boolean resolveEntities, String[] collections)` Deprecated. As of XDBC 3.0, replaced by `XDMPDocOptions`
`XDMPDocInsertStream`	`openDocInsertStream(String uri, Locale locale, boolean resolveEntities, XDMPPermission[] permissions)` Deprecated. As of XDBC 3.0, replaced by `XDMPDocOptions`
`XDMPDocInsertStream`	`openDocInsertStream(String uri, Locale locale, boolean resolveEntities, XDMPPermission[] permissions, String[] collections)` Deprecated. As of XDBC 3.0, replaced by `XDMPDocOptions`
`XDMPDocInsertStream`	`openDocInsertStream(String uri, Locale locale, boolean resolveEntities, XDMPPermission[] permissions, String[] collections, int quality, String namespace, int repair)` Deprecated. As of XDBC 3.0, replaced by `XDMPDocOptions`
`XDMPDocInsertStream`	`openDocInsertStream(String uri, Locale locale, boolean resolveEntities, XDMPPermission[] permissions, String[] collections, int quality, String namespace, int repair, String[] placeKeys)` Deprecated. As of XDBC 3.0, replaced by `XDMPDocOptions`
`XDMPDocInsertStream`	`openDocInsertStream(String uri, Locale locale, boolean resolveEntities, XDMPPermission[] permissions, String[] collections, int quality, String namespace, int repair, String[] placeKeys, int format, String language)` Deprecated. As of XDBC 3.0, replaced by `XDMPDocOptions`
`XDMPDocInsertStream`	`openDocInsertStream(String uri, XDMPDocOptions docOpts)` Opens a document insert stream to insert a document in the database.
`void`	`rollback()` NOTE: This method is NOT currently supported.
`void`	`setAutoCommit(boolean autoCommit)` NOTE: This method is NOT currently supported.
`void`	`setLocale(Locale locale)` Sets the locale for this connection object.
`static void`	`setMaxOpenDocInsertStreams(int n)` Sets the maximum allowable number of open doc insert stream objects at any one time.
`static void`	`setMaxOpenResultSequences(int n)` Sets the maximum allowable number of open result sequence objects at any one time.
`void`	`setReadOnly(boolean readOnly)` NOTE: This method is NOT currently supported.
`void`	`setTimeZone(TimeZone tz)` Sets the timezone for this connection object.
`void`	`setTransactionIsolation(int level)` NOTE: This method is NOT currently supported.
`String`	`toString()` Returns a string representation of the connection object.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XDMPConnection

public XDMPConnection(String host,
                      int port,
                      String prompt)
               throws XDBCException

Constructor for XDMPConnection object.
Parameters:: host - a valid hostname with a Mark Logic XDMP server installed and running; port - the port number of the Mark Logic XDMP server.; prompt - a prompt provided to select the appropriate credentials to use.
Throws:: XDBCException - if a database connection error occurs.
See Also:: XDMPAuthenticator.setCredentials(java.lang.String, int, java.lang.String, java.lang.String, java.lang.String)

XDMPConnection

public XDMPConnection(String host,
                      int port)
               throws XDBCException

Constructor for XDMPConnection object.
Parameters:: host - a valid hostname with a Mark Logic XDMP server installed and running; port - the port number of the Mark Logic XDMP server.
Throws:: XDBCException - if a database connection error occurs.

XDMPConnection

public XDMPConnection(String host,
                      int port,
                      String user,
                      String password)
               throws XDBCException

Constructor for XDMPConnection object.
Parameters:: host - a valid hostname with a Mark Logic XDMP server installed and running; port - the port number of the Mark Logic XDMP server.; user - the user to connect as.; password - the password to connect with.
Throws:: XDBCException - if a database connection error occurs.
See Also:: XDMPAuthenticator.setCredentials(java.lang.String, int, java.lang.String, java.lang.String, java.lang.String)

Method Detail

finalize

protected void finalize()

Finalizer for XDMPConnection.

close

public void close()
           throws XDBCException

Releases a XDBCConnection's database and XDBC resources immediately instead of waiting for them to be automatically released. This does not necessarily close statements and result sequences generated from the connection.

Specified by:: close in interface XDBCConnection

Throws:: XDBCException - if a database access error occurs.

commit

public void commit()
            throws XDBCException

NOTE: This method is NOT currently supported.

Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by the connection.

Specified by:: commit in interface XDBCConnection

Throws:: XDBCException - if a database access error occurs.

createStatement

public XDBCStatement createStatement()
                              throws XDBCException

Creates a Statement object for sending XQuery expressions to the database.

Specified by:: createStatement in interface XDBCConnection

Returns:: a new XDBCStatement object.
Throws:: XDBCException - if a database access error occurs.

openDocInsertStream

public XDMPDocInsertStream openDocInsertStream()
                                        throws XDBCException

Opens a document insert stream to insert multiple documents in the database in a single transaction. Each successive document needs to be started by calling newDocument(). To commit all documents, call commit().

Returns:: XDMPDocInsertStream object to use for inserting.
Throws:: XDBCException - if a database access error occurs.
See Also:: XDMPDocInsertStream.newDocument(String, com.marklogic.xdmp.XDMPDocOptions), XDMPDocInsertStream.commit()