ai.grakn.GraknSession Maven / Gradle / Ivy

Go to download

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

There is a newer version: 1.4.3

/*
 * GRAKN.AI - THE KNOWLEDGE GRAPH
 * Copyright (C) 2018 Grakn Labs Ltd
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */

package ai.grakn;


import javax.annotation.CheckReturnValue;

/**
 * 
 *     Builds a {@link GraknSession}
 * 
 *
 * 
 *     This class facilitates the construction of Grakn Graphs by determining which session should be built.
 *     The graphs produced by a session are singletons bound to a specific keyspace.
 *
 * 
 *
 * @author fppt
 */
public interface GraknSession extends AutoCloseable {

    /**
     * Gets a new transaction bound to the keyspace of this Session.
     *
     * @param transactionType The type of transaction to open see {@link GraknTxType} for more details
     * @return A new Grakn graph transaction
     * @see GraknTx
     */
    @CheckReturnValue
    GraknTx transaction(GraknTxType transactionType);

    /**
     * Closes the main connection to the graph. This should be done at the end of using the graph.
     *
     */
    void close();

    /**
     * Use to determine which {@link Keyspace} this {@link GraknSession} is interacting with.
     *
     * @return The {@link Keyspace} of the knowledge base this {@link GraknSession} is interacting with.
     */
    ai.grakn.Keyspace keyspace();
}