com.treasuredata.jdbc.command.ClientAPI Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of td-jdbc Show documentation
JDBC Driver for Accessing Treasure Data
There is a newer version: 0.5.11
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package com.treasuredata.jdbc.command;

import com.treasure_data.client.ClientException;
import com.treasuredata.jdbc.TDResultSetBase;
import com.treasuredata.jdbc.TDResultSetMetaData;
import com.treasure_data.model.DatabaseSummary;
import com.treasure_data.model.Job;
import com.treasure_data.model.JobSummary;
import com.treasure_data.model.TableSummary;
import org.msgpack.unpacker.Unpacker;

import java.io.File;
import java.util.List;

public interface ClientAPI
{
    public static class ExtUnpacker
    {
        private File file;
        private Unpacker unpacker;

        public ExtUnpacker(File file, Unpacker unpacker)
        {
            this.file = file;
            this.unpacker = unpacker;
        }

        public File getFile()
        {
            return file;
        }

        public Unpacker getUnpacker()
        {
            return unpacker;
        }
    }

    // show all databases statement
    List showDatabases()
            throws ClientException;

    // show current database statement
    DatabaseSummary showDatabase()
            throws ClientException;

    // show table statement
    List showTables()
            throws ClientException;

    // select statement
    TDResultSetBase select(String sql)
            throws ClientException;

    TDResultSetBase select(String sql, int queryTimeout)
            throws ClientException;

    TDResultSetMetaData getMetaDataWithSelect1();

    boolean flush(); // for debugging

    JobSummary waitJobResult(Job job)
            throws ClientException;

    Unpacker getJobResult(Job job)
            throws ClientException;

    ExtUnpacker getJobResult2(Job job)
            throws ClientException;

    void close()
            throws ClientException;
}