Berkeley DB XML: Berkeley DB XML: C++ Handle Methods (version 2.5.16)

Berkeley DB XML: C++ Handle Methods (version 2.5.16)

C++ Handle Methods	Description
DbXml::dbxml_version	Get the release number.
DbXml::setLogCategory	Set the logging category.
DbXml::setLogLevel	Set the logging level.
XmlCompression::compress	Compresses data before it is added to a container.
XmlCompression::decompress	Decompresses data when it is retrieved from a container.
XmlCompression	Used to implement customized compression.
XmlContainer::addAlias	Adds a alias for the container name.
XmlContainer::addDefaultIndex	Add a default index to the container.
XmlContainer::addIndex	Adds an index specification.
XmlContainerConfig	Used to configure a container.
XmlContainerConfig::setAllowCreate	Sets whether to create the container if it does not exist.
XmlContainerConfig::setAllowValidation	Sets whether XML is validated.
XmlContainerConfig::setChecksum	Sets whether to use checksum verification.
XmlContainerConfig::setCompressionName	Sets the compression to be used.
XmlContainerConfig::setContainerType	Sets the container type.
XmlContainerConfig::setEncrypted	Sets whether to use encryption.
XmlContainerConfig::setExclusiveCreate	Sets whether to throw an exception if the container exists.
XmlContainerConfig::setIndexNodes	Sets whether to index nodes or documents.
XmlContainerConfig::setMode	Sets the mode of the container files.
XmlContainerConfig::setMultiversion	Enable multiversion concurrency control.
XmlContainerConfig::setNoMMap	Sets whether to map containers into process memory.
XmlContainerConfig::setPageSize	Sets the page size used by the container.
XmlContainerConfig::setReadOnly	Sets whether the container is read only.
XmlContainerConfig::setReadUncommitted	Enable dirty reads.
XmlContainerConfig::setSequenceIncrement	Set the sequence number generation cache size.
XmlContainerConfig::setStatistics	Sets whether to store structural statistics.
XmlContainerConfig::setThreaded	Sets whether to return the container handle as free-threaded.
XmlContainerConfig::setTransactional	Sets whether transactions are used.
XmlContainerConfig::setTransactionNotDurable	Sets whether operations are not durable.
XmlContainer::deleteDefaultIndex	Delete the container's default index.
XmlContainer::deleteDocument	Delete a document from the container.
XmlContainer::deleteIndex	Delete the specified index.
XmlContainer::getAllDocuments	Get all documents in the container.
XmlContainer::getAutoIndexing	Get the state of automatic indexing.
XmlContainer::getContainerConfig	Get the container's settings.
XmlContainer::getContainerType	Get the container's type.
XmlContainer::getDocument	Get the specified document.
XmlContainer::getFlags	Get the flags used to open the container.
XmlContainer::getIndexNodes	Return true if indexing nodes.
XmlContainer::getIndexSpecification	Get the index specification.
XmlContainer::getManager	Get the XmlManager object for this container.
XmlContainer::getName	Get the container's name.
XmlContainer::getNode	Get the specified node.
XmlContainer::getNumDocuments	Get the number of documents in the container.
XmlContainer::getPageSize	Return database page size.
XmlContainer::lookupIndex	Return all the documents matching a specified index.
XmlContainer::lookupStatistics	Return an XmlStatistics object for a specified index.
XmlContainer	An XmlContainer.
XmlContainer::putDocumentAsEventWriter	Add a document to the container using XmlEventWriter.
XmlContainer::putDocument	Add a document to the container.
XmlContainer::removeAlias	Remove a named alias for the container.
XmlContainer::replaceDefaultIndex	Replace the container's default index.
XmlContainer::replaceIndex	Replace an index of a specified type.
XmlContainer::setAutoIndexing	Set the state of automatic indexing.
XmlContainer::setIndexSpecification	Set the index specification.
XmlContainer::sync	Flush container database state to disk.
XmlContainer::updateDocument	Update an existing XmlDocument
XmlData::adoptBuffer	Take ownership of the buffer.
XmlData::get_data	Get a pointer to the data.
XmlData::getReservedSize	Return the amount of reserved space in bytes.
XmlData::get_size	Get size of the data in bytes.
XmlData	XmlData instance
XmlData::reserve	Reserve space (will resize if necessary).
XmlData::set_size	Set the size of the data in bytes.
XmlDebugListener::end	TBD.
XmlDebugListener::enter	TBD.
XmlDebugListener::error	TBD.
XmlDebugListener::exit	TBD.
XmlDebugListener	An XmlDebugListener
XmlDebugListener::start	TBD.
XmlDocument::fetchAllData	Retrieve all document content and metadata.
XmlDocument::getContentAsEventReader	Retrieve content as an XmlEventReader.
XmlDocument::getContentAsEventWriter	Retrieve content into an XmlEventWriter.
XmlDocument::getContentAsXmlInputStream	Retrieve content as an input stream.
XmlDocument::getContent	Retrieve content.
XmlDocument::getMetaDataIterator	Get an XmlMetaDataIterator.
XmlDocument::getMetaData	Retrieve a single metadata value.
XmlDocument::getName	Get the document's name.
XmlDocument	An XmlDocument.
XmlDocument::removeMetaData	Removes a single metadata value.
XmlDocument::setContentAsEventReader	Set the document's content from an XmlEventReader.
XmlDocument::setContentAsXmlInputStream	Set the document's content from an input stream.
XmlDocument::setContent	Set the document's content.
XmlDocument::setMetaData	Set a metadata value for the document.
XmlDocument::setName	Set the document's name.
XmlEventReader::close	Release resources for reader.
XmlEventReader::getAttributeCount	Return the number of attributes for an element event.
XmlEventReader::getAttributeLocalName	Get attribute's local name.
XmlEventReader::getAttributeNamespaceURI	Get attribute's namespace URI.
XmlEventReader::getAttributePrefix	Get attribute's namespace prefix.
XmlEventReader::getAttributeValue	Get attribute's value.
XmlEventReader::encodingSet	Check if the encoding is explicitly set.
XmlEventReader::getEncoding	Return the encoding of the document.
XmlEventReader::getSystemId	Return the System ID for for the document.
XmlEventReader::getVersion	Return the XML version string for the document.
XmlEventReader::isStandalone	Check if document is standalone XML.
XmlEventReader::standaloneSet	Check if the standalone attribute is set.
XmlEventReader::getEventType	Return the type of the current event.
XmlEventReader::getLocalName	Return the name of the current element event.
XmlEventReader::getNamespaceURI	Return the namespace URI of the current element event.
XmlEventReader::getPrefix	Return the namespace prefix for the current element event.
XmlEventReader::getValue	Return the value of the current event.
XmlEventReader::hasEmptyElementInfo	Check if object will return empty element state.
XmlEventReader::hasEntityEscapeInfo	Check if object has information about entities.
XmlEventReader::hasNext	Check if there are more events.
XmlEventReader::isAttributeSpecified	Check if an attribute is specified.
XmlEventReader::isEmptyElement	Check current element is empty.
XmlEventReader::isWhiteSpace	Check if current text value is white space.
XmlEventReader	Read XML events.
XmlEventReader::needsEntityEscape	Check if text or attribute value needs escaping.
XmlEventReader::next	Move to the next event.
XmlEventReader::nextTag	Move to the next StartElement or EndElement event.
XmlEventReader::getExpandEntities	Get whether to expand entities.
XmlEventReader::setExpandEntities	Set whether to expand entities.
XmlEventReader::getReportEntityInfo	Get whether to report entity information.
XmlEventReader::setReportEntityInfo	Set whether to report entity information.
XmlEventReaderToWriter	Convert XmlEventReader to XmlEventWriter
XmlEventReaderToWriter::start	Begin processing events.
XmlEventWriter::close	Release resources for the writer.
XmlEventWriter	Write XML events.
XmlEventWriter::writeAttribute	Write an attribute.
XmlEventWriter::writeDTD	Write a DTD or reference.
XmlEventWriter::writeEndDocument	Write an EndDocument event.
XmlEventWriter::writeEndElement	Write an EndElement event.
XmlEventWriter::writeEndEntity	Write an EndEntity event.
XmlEventWriter::writeProcessingInstruction	Write a ProcessingInstruction.
XmlEventWriter::writeStartDocument	Write a StartDocument event.
XmlEventWriter::writeStartElement	Write a StartElement event.
XmlEventWriter::writeStartEntity	Write a StartEntityReference event.
XmlEventWriter::writeText	Write a Text event.
XmlException::getDbErrno	Get DB error number.
XmlException::getExceptionCode	Get ExceptionCode.
XmlException::getQueryColumn	Get column for query error.
XmlException::getQueryFile	Get file for query error.
XmlException::getQueryLine	Get line for query error.
XmlException	BDB XML exceptions.
XmlException::what	Get error string.
XmlIndexLookup::execute	Execute the index lookup operation.
XmlIndexLookup	An XmlIndexLookup.
XmlIndexLookup::setContainer	Set the target container for the lookup.
XmlIndexLookup::setHighBound	Set the high bound for a range lookup.
XmlIndexLookup::setIndex	Set the index to be used for the lookup.
XmlIndexLookup::setLowBound	Set the lower bound for the lookup.
XmlIndexLookup::setNode	Set the target node name for the lookup.
XmlIndexLookup::setParent	Set the parent node for edge index lookups.
XmlIndexSpecification::addDefaultIndex	Add a default index.
XmlIndexSpecification::addIndex	Add an index
XmlIndexSpecification::deleteDefaultIndex	Delete the index from the default specification.
XmlIndexSpecification::deleteIndex	Delete an index.
XmlIndexSpecification::find	Find the index for a specific node.
XmlIndexSpecification::getDefaultIndex	Get the default index.
XmlIndexSpecification::getValueType	Get the XmlValue::type from an index string.
XmlIndexSpecification	An XmlIndexSpecification.
XmlIndexSpecification::next	Get the next index in the index specification.
XmlIndexSpecification::replaceDefaultIndex	Replace the default index.
XmlIndexSpecification::replaceIndex	Replace the index for a node.
XmlIndexSpecification::reset	Reset the index iterator.
XmlIndexSpecification::getAutoIndexing	Get the current auto-indexing state.
XmlIndexSpecification::setAutoIndexing	Set the current auto-indexing state.
XmlInputStream::curPos	Return the current position in the stream.
XmlInputStream	An XmlInputStream
XmlInputStream::readBytes	Read bytes from the stream.
XmlManager::compactContainer	Compact the databases comprising the container.
XmlManager::createContainer	Create an XmlContainer
XmlManager::createDocument	Instantiate an XmlDocument object.
XmlManager::createIndexLookup	Instantiate an XmlIndexLookup object.
XmlManager::createLocalFileInputStream	Create an input stream to a file on disk.
XmlManager::createMemBufInputStream	Create an input stream to a memory buffer.
XmlManager::createQueryContext	Instantiate an XmlQueryContext object.
XmlManager::createResults	Instantiate an empty XmlResults object.
XmlManager::createStdInInputStream	Create an input stream to the console.
XmlManager::createTransaction	Instantiate an XmlTransaction object.
XmlManager::createUpdateContext	Instantiate an XmlUpdateContext object.
XmlManager::createURLInputStream	Create an input stream to the specified URL.
XmlManager::dumpContainer	Dump the container.
XmlManager::existsContainer	Determine if container exists.
XmlManager::getDB_ENV	Get the database environment.
XmlManager::getDefaultContainerConfig	Get a copy of the default XmlContainerConfig.
XmlManager::getFlags	Get the flags used to open the manager.
XmlManager::getHome	Get the environment home directory.
XmlManager::getImplicitTimezone	Get the implicit timezone used for queries.
XmlManager::loadContainer	Load the container.
XmlManager	An XmlManager.
XmlManager::openContainer	Open an already existing XmlContainer.
XmlManager::prepare	Get an XmlQueryExpression object.
XmlManager::query	Execute a query.
XmlManager::registerCompression	The XmlCompression that implements user defined compression.
XmlManager::registerResolver	The XmlResolver that implements file resolution policy.
XmlManager::reindexContainer	Reindex the container.
XmlManager::removeContainer	Delete the container.
XmlManager::renameContainer	Rename the container.
XmlManager::setDefaultContainerConfig	Set the default XmlContainerConfig.
XmlManager::setDefaultContainerFlags	Set the default flags.
XmlManager::setDefaultContainerType	Set the default container type.
XmlManager::setDefaultPageSize	Set the underlying database page size.
XmlManager::setDefaultSequenceIncrement	Set the sequence number generation cache size.
XmlManager::setImplicitTimezone	Set the implicit timezone used for queries.
XmlManager::truncateContainer	Truncate the container.
XmlManager::upgradeContainer	Upgrade the container.
XmlManager::verifyContainer	Verify the container.
XmlMetaDataIterator	A metadata iterator.
XmlMetaDataIterator::next	Retrieve the next metadata item.
XmlMetaDataIterator::reset	Retrieve the first metadata item.
XmlQueryContext::clearNamespaces	Remove all namespaces.
XmlQueryContext::getReturnType	Get the return type.
XmlQueryContext::interruptQuery	Interrupt a running query.
XmlQueryContext	An XQuery query context
XmlQueryContext::removeNamespace	Remove the specified namespace.
XmlQueryContext::getBaseURI	Gets the Base URI.
XmlQueryContext::setBaseURI	Sets the Base URI.
XmlQueryContext::getDebugListener	Gets the XmlDebugListener.
XmlQueryContext::setDebugListener	Sets the XmlDebugListener.
XmlQueryContext::setDefaultCollection	Set default collection for fn:collection().
XmlQueryContext::getEvaluationType	Get the evaluation type.
XmlQueryContext::setEvaluationType	Set the evaluation type.
XmlQueryContext::getNamespace	Retrieve a namespace URI.
XmlQueryContext::setNamespace	Add a namespace.
XmlQueryContext::getQueryTimeoutSeconds	Get query timeout value.
XmlQueryContext::setQueryTimeoutSeconds	Set query timeout value.
XmlQueryContext::setReturnType	Set the return type.
XmlQueryContext::getVariableValue	Return the variable's value.
XmlQueryContext::setVariableValue	Set an external XQuery variable.
XmlQueryExpression::execute	Evaluate the query.
XmlQueryExpression::getQuery	Return the query as a string.
XmlQueryExpression::getQueryPlan	Return the query plan as a string.
XmlQueryExpression::isUpdateExpression	Returns true if the query is an updating expression.
XmlQueryExpression	An XmlQueryExpression.
XmlResolver	Base class for file resolution policy.
XmlResolver::resolveCollection	Resolve URI to an XmlResults.
XmlResolver::resolveDocument	Resolve URI to an XmlValue.
XmlResolver::resolveEntity	Resolve an entity to an XmlInputStream.
XmlResolver::resolveExternalFunction	Resolve URI and name to an XmlExternalFunction.
XmlResolver::resolveModuleLocation	Resolve an XQuery module namespace to locations.
XmlResolver::resolveModule	Resolve an XQuery module reference.
XmlResolver::resolveSchema	Resolve schema to an XmlInputStream.
XmlResults::add	Adds an XmlValue to the end of the result set.
XmlResults::asEventWriter	Returns an XmlEventWriter for the result set.
XmlResults::concatResults	Concatenates one result set into another creating a transient copy.
XmlResults::copyResults	Creates a transient copy of the result set.
XmlResults::getEvaluationType	Returns the evaluation type of the result set.
XmlResults::hasNext	Is there another value in the results set.
XmlResults::hasPrevious	Is there a previous value in the results set.
XmlResults	Query results.
XmlResults::next	Retrieve the next element in the results set.
XmlResults::peek	Retrieve current value with no iterator movement.
XmlResults::previous	Retrieve the previous element in the result set.
XmlResults::reset	The iterator is placed at the beginning of the result set.
XmlResults::size	Returns the number of elements in the result set.
XmlStackFrame::getPreviousStackFrame	Return the previous stack frame object.
XmlStackFrame::getQueryColumn	Return the current column in the query.
XmlStackFrame::getQueryFile	Return the query's file name.
XmlStackFrame::getQueryLine	Return the current line in the query.
XmlStackFrame::getQueryPlan	Return the current state of the query plan.
XmlStackFrame	An XmlStackFrame
XmlStackFrame::query	Execute a query from the current point of execution.
XmlStatistics::getNumberOfIndexedKeys	The total number of index keys.
XmlStatistics::getNumberOfUniqueKeys	The number of unique index keys.
XmlStatistics	Encapsulates index statistics.
XmlTransaction::abort	Abort a transaction.
XmlTransaction::commit	Commit a transaction.
XmlTransaction::createChild	Create a child transaction.
XmlTransaction::getDB_TXN	Get the underlying DB_TXN object.
XmlTransaction	Transaction object.
XmlUpdateContext	An XmlUpdateContext
XmlValue::asBoolean	Return value as a boolean.
XmlValue::asDocument	Return value as XmlDocument.
XmlValue::asEventReader	Return value as XmlEventReader.
XmlValue::asNumber	Return value as a double.
XmlValue::asString	Return value as a string.
XmlValue::equals	Compare two XmlValue objects.
XmlValue::getAttributes	Get the node's attributes.
XmlValue::getFirstChild	Get the node's first child.
XmlValue::getLastChild	Get the node's last child.
XmlValue::getLocalName	Get the node's local name.
XmlValue::getNamespaceURI	Get the node's namespace URI.
XmlValue::getNextSibling	Get the node's next sibling node.
XmlValue::getNodeHandle	Return a string node handle for the value.
XmlValue::getNodeName	Get the name of the node value.
XmlValue::getNodeType	Get the node type of the node.
XmlValue::getNodeValue	Get the value of the node.
XmlValue::getOwnerElement	Get the node's owner element.
XmlValue::getParentNode	Get the node's parent node.
XmlValue::getPrefix	Get the node's namespace prefix.
XmlValue::getPreviousSibling	Get the node's previous sibling node.
XmlValue::getType	Get the type enumeration of the value.
XmlValue::getTypeName	Get the name of the type.
XmlValue::getTypeURI	Get the URI for the type.
XmlValue::isBinary	Check if value is binary.
XmlValue::isBoolean	Check if value is a boolean.
XmlValue::isNode	Check if value is node.
XmlValue::isNull	Check if the value is initialized.
XmlValue::isNumber	Check if value is a number .
XmlValue::isString	Check if value is a string .
XmlValue::isType	Check type of value.
XmlValue	A single result value.
XmlValue::operator==	Compare two XmlValue objects.