rapture.common.api.ScriptStructuredApi 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.
 */

/**
 * This is an autogenerated file. You should not edit this file as any changes
 * will be overwritten.
 */

package rapture.common.api;
import rapture.common.CallingContext;
import rapture.common.exception.RaptureException;
import java.util.List;
import java.util.Map;
import rapture.common.StoredProcedureParams;
import rapture.common.StoredProcedureResponse;
import rapture.common.TableIndex;
import rapture.common.StructuredRepoConfig;
import rapture.common.ForeignKey;


@SuppressWarnings("all")
public interface ScriptStructuredApi {
     /**
     * 
     * 
     */
     void createStructuredRepo(String uri, String config);

     /**
     * 
     * 
     */
     void deleteStructuredRepo(String uri);

     /**
     * 
     * 
     */
     Boolean structuredRepoExists(String uri);

     /**
     * 
     * 
     */
     StructuredRepoConfig getStructuredRepoConfig(String uri);

     /**
     * 
     * 
     */
     List getStructuredRepoConfigs();

     /**
     * 
     * 
     */
     void createTableUsingSql(String schema, String rawSql);

     /**
     * 
     * 
     */
     void createTable(String tableUri, Map columns);

     /**
     * 
     * 
     */
     void dropTable(String tableUri);

     /**
     * 
     * 
     */
     Boolean tableExists(String tableUri);

     /**
     * 
     * 
     */
     List getSchemas();

     /**
     * 
     * 
     */
     List getTables(String repoUri);

     /**
     * 
     * 
     */
     Map describeTable(String tableUri);

     /**
     * 
     * 
     */
     void addTableColumns(String tableUri, Map columns);

     /**
     * 
     * 
     */
     void deleteTableColumns(String tableUri, List columnNames);

     /**
     * 
     * 
     */
     void updateTableColumns(String tableUri, Map columns);

     /**
     * 
     * 
     */
     void renameTableColumns(String tableUri, Map columnNames);

     /**
     * 
     * 
     */
     void createIndex(String tableUri, String indexName, List columnNames);

     /**
     * 
     * 
     */
     void dropIndex(String tableUri, String indexName);

     /**
     * 
     * 
     */
     List getIndexes(String tableUri);

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

     /**
     * 
     * 
     */
     List> selectUsingSql(String schema, String rawSql);

     /**
     * 
     * 
     */
     List> selectRows(String tableUri, List columnNames, String where, List order, Boolean ascending, int limit);

     /**
     * 
     * 
     */
     void insertUsingSql(String schema, String rawSql);

     /**
     * 
     * 
     */
     void insertRow(String tableUri, Map values);

     /**
     * 
     * 
     */
     void insertRows(String tableUri, List> values);

     /**
     * 
     * 
     */
     void deleteUsingSql(String schema, String rawSql);

     /**
     * 
     * 
     */
     void deleteRows(String tableUri, String where);

     /**
     * 
     * 
     */
     void updateUsingSql(String schema, String rawSql);

     /**
     * 
     * 
     */
     void updateRows(String tableUri, Map values, String where);

     /**
     * 
     * 
     */
     Boolean begin();

     /**
     * 
     * 
     */
     Boolean commit();

     /**
     * 
     * 
     */
     Boolean rollback();

     /**
     * 
     * 
     */
     Boolean abort(String transactionId);

     /**
     * 
     * 
     */
     List getTransactions();

     /**
     * 
     * 
     */
     String getDdl(String uri, Boolean includeTableData);

     /**
     * 
     * 
     */
     String getCursorUsingSql(String schema, String rawSql);

     /**
     * 
     * 
     */
     String getCursor(String tableUri, List columnNames, String where, List order, Boolean ascending, int limit);

     /**
     * 
     * 
     */
     String getCursorForJoin(List tableUris, List columnNames, String from, String where, List order, Boolean ascending, int limit);

     /**
     * 
     * 
     */
     List> next(String tableUri, String cursorId, int count);

     /**
     * 
     * 
     */
     List> previous(String tableUri, String cursorId, int count);

     /**
     * 
     * 
     */
     void closeCursor(String tableUri, String cursorId);

     /**
     * 
     * 
     */
     void createProcedureCallUsingSql(String procUri, String rawSql);

     /**
     * 
     * 
     */
     StoredProcedureResponse callProcedure(String procUri, StoredProcedureParams params);

     /**
     * 
     * 
     */
     void dropProcedureUsingSql(String procUri, String rawSql);

     /**
     * 
     * 
     */
     String getPrimaryKey(String tableUri);

     /**
     * 
     * 
     */
     List getForeignKeys(String tableUri);

}