rapture.structured.StructuredStore Maven / Gradle / Ivy

Go to download
/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2011-2016 Incapture Technologies LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package rapture.structured;

import java.util.List;
import java.util.Map;

import javax.sql.DataSource;

import rapture.common.CallingContext;
import rapture.common.ForeignKey;
import rapture.common.StoredProcedureParams;
import rapture.common.StoredProcedureResponse;
import rapture.common.TableIndex;
import rapture.common.TableMeta;

public interface StructuredStore {

    DataSource getDataSource();

    SqlGenerator getSqlGenerator();

    void setInstance(String instance);

    void setConfig(Map config, String authority);

    void drop();

    boolean commit(String txId);

    boolean rollback(String txId);

    Boolean createTableUsingSql(CallingContext context, String sql);

    Boolean createTable(String tableName, Map columns);

    Boolean dropTable(String tableName);

    Boolean tableExists(String tableName);

    List getTables();

    TableMeta describeTable(String tableName);

    Boolean addTableColumns(String tableName, Map columns);

    Boolean deleteTableColumns(String tableName, List columnNames);

    Boolean updateTableColumns(String tableName, Map columns);

    Boolean renameTableColumns(String tableName, Map columnNames);

    List> selectUsingSql(CallingContext context, String sql);

    List> selectJoinedRows(List tables, List columnNames, String from, String where,
                                               List order, Boolean ascending, int limit);

    List> selectRows(String tableName, List columnNames, String where, List order, Boolean ascending, int limit);

    Boolean insertUsingSql(CallingContext context, String sql);

    Boolean insertRow(String tableName, Map values);

    Boolean insertRows(String tableName, List> values);

    Boolean deleteUsingSql(CallingContext context, String sql);

    Boolean deleteRows(String tableName, String where);

    Boolean updateUsingSql(CallingContext context, String sql);

    Boolean updateRows(String tableName, Map values, String where);

    Boolean createIndex(String tableName, String indexName, List columnNames);

    Boolean dropIndex(String indexName);

    List getIndexes(String tableName);

    String getPrimaryKey(String tableName);

    List getForeignKeys(String tableName);

    String getDdl(String tableName, Boolean includeTableData);

    String getCursorUsingSql(CallingContext context, String sql);

    String getCursor(String tableName, List columnNames, String where, List order, Boolean ascending, int limit);

    String getCursorForJoin(List tables, List columnNames, String from, String where, List order, Boolean ascending, int limit);

    List> next(String tableName, String cursorId, int count);

    List> previous(String tableName, String cursorId, int count);

    Boolean closeCursor(String tableName, String cursorId);

    void executeDdl(String ddl);

    Boolean createProcedureCallUsingSql(CallingContext context, String sql);

    StoredProcedureResponse callProcedure(CallingContext context, String procName, StoredProcedureParams params);

    Boolean dropProcedureUsingSql(CallingContext context, String rawSql);
}