public interface ContentbaseMetaData
Meta-data about a contentbase as represented by a Session
instance. The methods of this
class that throw RequestException
may make one or more calls the server to obtain
needed information. Those which don't throw exceptions return local information.
All server-query methods are lazy and do temporary caching. That is, no server calls are made until you invoke a method that needs information from the server. And once some information is fetched from the server, local copies will be returned on subsequent calls, until the data ages out. The time-to-live for cached information is about 60 seconds.
Modifier and Type | Method and Description |
---|---|
java.math.BigInteger |
getContentBaseId()
Return the numeric database ID of the contentbase.
|
java.lang.String |
getContentBaseName()
Return the name of the contentbase associated with the
Session . |
int |
getDriverMajorVersion()
The driver (XCC) major release version.
|
int |
getDriverMinorVersion()
The driver (XCC) minor release version.
|
int |
getDriverPatchVersion()
The driver (XCC) patch release version.
|
java.lang.String |
getDriverVersionString()
The driver (XCC) release version, as a String.
|
java.math.BigInteger[] |
getForestIds()
Return the IDs of forests attached to the contentbase associated with the
Session . |
java.util.Map<java.lang.String,java.math.BigInteger> |
getForestMap()
Returns a
Map of forest names to forest IDs. |
java.lang.String[] |
getForestNames()
Return the names of the forests attached to the contnetbase associated with the
Session . |
int |
getServerMajorVersion()
Return the server major release version number.
|
int |
getServerMinorVersion()
Return ther server minor release version number.
|
int |
getServerPatchVersion()
Return ther server patch release version number.
|
java.lang.String |
getServerVersionString()
Return a String version of the MarkLogic Server.
|
Session |
getSession()
The
Session object that created this object. |
java.lang.String |
getUser()
Returns the user identity associated with the
Session from which this object was
obtained. |
java.lang.String getDriverVersionString()
int getDriverMajorVersion()
int getDriverMinorVersion()
int getDriverPatchVersion()
java.lang.String getUser()
Returns the user identity associated with the Session
from which this object was
obtained.
This property may also be obtained directly from the Session
object via the
UserCredentials
object returned by the
Session.getUserCredentials()
method. It is included here for
completeness.
java.lang.String getContentBaseName() throws RequestException
Session
. Unlike the similar
method Session.getContentBaseName()
, this method makes a call to
the server to obtain the name. Session
instances may be created without an explicit
contentbase name (use a default) or with a numeric ID. This method determines the actual
alphanumeric name of the contentbase.RequestException
- If there is a problem communicating with the server.java.math.BigInteger getContentBaseId() throws RequestException
getContentBaseName()
,
this method makes a call to the server to obtain the ID, regardless of how the
Session
was created.RequestException
- If there is a problem communicating with the server.java.math.BigInteger[] getForestIds() throws RequestException
Session
.BigInteger
values.RequestException
- If there is a problem communicating with the server.java.lang.String[] getForestNames() throws RequestException
Session
.String
s.RequestException
- If there is a problem communicating with the server.java.util.Map<java.lang.String,java.math.BigInteger> getForestMap() throws RequestException
Map
of forest names to forest IDs. The keys of the Map
are the
forest names and the values are BigInteger
values that represent the forest IDs.Map
, keyed by forest name, of the forest IDs.RequestException
- If there is a problem communicating with the server.java.lang.String getServerVersionString() throws RequestException
RequestException
- If there is a problem communicating with the server.int getServerMajorVersion() throws RequestException
RequestException
- If there is a problem communicating with the server.int getServerMinorVersion() throws RequestException
RequestException
- If there is a problem communicating with the server.int getServerPatchVersion() throws RequestException
RequestException
- If there is a problem communicating with the server.Copyright © 2024 MarkLogic Corporation
Complete online documentation for MarkLogic Server, XQuery and related components may be found at developer.marklogic.com