com.clickhouse.client.cli.ClickHouseCommandLineClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of clickhouse-cli-client Show documentation

Wrapper of ClickHouse native command-line client planed to be deprecated from version 0.6.0 and removed at 0.7.0

There is a newer version: 0.6.4

Show newest version

package com.clickhouse.client.cli;

import java.io.IOException;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;

import com.clickhouse.client.AbstractClient;
import com.clickhouse.client.ClickHouseException;
import com.clickhouse.client.ClickHouseNode;
import com.clickhouse.client.ClickHouseProtocol;
import com.clickhouse.client.ClickHouseRequest;
import com.clickhouse.client.ClickHouseResponse;
import com.clickhouse.client.UnsupportedProtocolException;
import com.clickhouse.client.cli.config.ClickHouseCommandLineOption;
import com.clickhouse.config.ClickHouseOption;
import com.clickhouse.logging.Logger;
import com.clickhouse.logging.LoggerFactory;

/**
 * Wrapper of ClickHouse native command-line client.
 */
// deprecate from version 0.6.0
@Deprecated
public class ClickHouseCommandLineClient extends AbstractClient {
    private static final Logger log = LoggerFactory.getLogger(ClickHouseCommandLineClient.class);

    static final List SUPPORTED = Collections
            .unmodifiableList(Arrays.asList(ClickHouseProtocol.LOCAL, ClickHouseProtocol.TCP));

    @Override
    protected boolean checkHealth(ClickHouseNode server, int timeout) {
        try (ClickHouseCommandLine cli = getConnection(read(server).query("SELECT 1"));
                ClickHouseCommandLineResponse response = new ClickHouseCommandLineResponse(getConfig(), cli)) {
            return response.firstRecord().getValue(0).asInteger() == 1;
        } catch (Exception e) {
            // ignore
        }
        return false;
    }

    @Override
    protected ClickHouseCommandLine newConnection(ClickHouseCommandLine conn, ClickHouseNode server,
            ClickHouseRequest request) {
        if (conn != null) {
            closeConnection(conn, false);
        }

        return new ClickHouseCommandLine(request);
    }

    @Override
    protected boolean checkConnection(ClickHouseCommandLine connection, ClickHouseNode requestServer,
            ClickHouseNode currentServer, ClickHouseRequest request) {
        return false;
    }

    @Override
    protected void closeConnection(ClickHouseCommandLine conn, boolean force) {
        try {
            conn.close();
        } catch (Exception e) {
            log.warn("Failed to close http connection due to: %s", e.getMessage());
        }
    }

    @Override
    protected Collection getSupportedProtocols() {
        return SUPPORTED;
    }

    @Override
    protected ClickHouseResponse send(ClickHouseRequest sealedRequest) throws ClickHouseException, IOException {
        return new ClickHouseCommandLineResponse(sealedRequest.getConfig(), getConnection(sealedRequest));
    }

    @Override
    public boolean accept(ClickHouseProtocol protocol) {
        final String option;
        switch (protocol) {
            case LOCAL:
                option = ClickHouseCommandLine.DEFAULT_LOCAL_OPTION;
                break;
            case TCP:
                option = ClickHouseCommandLine.DEFAULT_CLIENT_OPTION;
                break;
            default:
                return false;
        }

        if (ClickHouseCommandLine.getCommandLine(getConfig(), option) == null) {
            throw new UnsupportedProtocolException(protocol,
                    "ClickHouse binary and docker command not found. Please modify option clickhouse_cli_path or docker_cli_path.");
        }
        return true;
    }

    @Override
    public final Class getOptionClass() {
        return ClickHouseCommandLineOption.class;
    }
}