io.sirix.access.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sirix-core Show documentation

SirixDB is a hybrid on-disk and in-memory document oriented, versioned database system. It has a lightweight buffer manager, stores everything in a huge persistent and durable tree and allows efficient reconstruction of every revision. Furthermore, SirixDB implements change tracking, diffing and supports time travel queries.

There is a newer version: 0.11.0

Show newest version

/**
 * Copyright (c) 2011, University of Konstanz, Distributed Systems Group All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted
 * provided that the following conditions are met: * Redistributions of source code must retain the
 * above copyright notice, this list of conditions and the following disclaimer. * Redistributions
 * in binary form must reproduce the above copyright notice, this list of conditions and the
 * following disclaimer in the documentation and/or other materials provided with the distribution.
 * * Neither the name of the University of Konstanz nor the names of its contributors may be used to
 * endorse or promote products derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL  BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * 
 * The access semantics is as follows:
 * 
 * 
 * There can only be a single {@link io.sirix.api.Database} instance per Database-Folder
 * There can be multiple {@link io.sirix.api.ResourceSession} instances per
 * {@link io.sirix.api.Database} linked uniquely to resources representing concrete
 * data-storages.
 * There can only be a single {@link io.sirix.api.xml.XmlNodeTrx} instance per
 * {@link io.sirix.api.ResourceSession}
 * There can be multiple {@link io.sirix.api.xml.XmlNodeReadOnlyTrx} instances per
 * {@link io.sirix.api.ResourceSession}.
 * 
 * 
 * Code examples:
 * 
 *  * // DatabaseConfiguration denoted the configuration for a connected set of data resources.
 * final DatabaseConfiguration dbConfig = new DatabaseConfiguration(new File("/path/to/db/location"));
 * // Creation of a database. Returns true if successful, false if not (including existence of the database)
 * Database.createDatabase(dbConfig);
 * // Getting of database instance, will be a singleton for the denoted path
 * final IDatabase database = Database.openDatabase(new File("/path/to/db/location");
 * // Creation of a resource within the db. The creation includes the setting of versioning, etc. It must take place only one.
 * final ResourceConfiguration resourceConfig = new ResourceConfiguration.Builder("coolResource").setRevision(ERevisioning.Differential).build();
 * database.createResource(resourceConfig);
 * // Getting access via a ISession
 * final SessionConfiguration sessionConfig = new SessionConfiguration("coolResource");
 * final ISession someSession = Session.beginSession(sessionConfig);
 *
 * final IWriteTransaction someWTX = someSession.beginWriteTransaction();
 * final IReadTransaction someRTX = someSession.beginReadTransaction();
 * final IReadTransaction someConcurrentRTX = someSession.beginReadTransaction();
 *
 * someWTX.abort();
 * someWTX.close();
 * someRTX.close();
 * someConcurrentRTX.close();
 * someSession.close();
 * database.close();
 * 
 *
 * 
 * Best practice to safely manipulate a sirix resource within a database if everything exists:
 *
 *  *         final IDatabase database = Database.openDatabase(new File("/path/to/db/location");
 *         final ISession session = Session.beginSession(new SessionConfiguration("existingResource");
 *         final IWriteTransaction wtx = session.beginWriteTransaction();
 *         try {
 *           wtx.insertElementAsFirstChild("foo", "", "");
 *           ...
 *           wtx.commit();
 *         } catch (final AbsTTException exc) {
 *           wtx.abort();
 *           throw new RuntimeException(exc);
 *         } finally {
 *           wtx.close();
 *         }
 *         session.close(); // Might also stand in the finally...
 *         database.close();
 * 
 *
 *
 *
 * @author Sebastian Graf, University of Konstanz
 */
package io.sirix.access;