com.huaweicloud.dws.client.DwsClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dws-client Show documentation
There is a newer version: 2.0.0-r0
package com.huaweicloud.dws.client;

import com.huaweicloud.dws.client.action.SqlAction;
import com.huaweicloud.dws.client.collector.ActionCollector;
import com.huaweicloud.dws.client.exception.DwsClientException;
import com.huaweicloud.dws.client.exception.InvalidException;
import com.huaweicloud.dws.client.function.SqlExceptionFunction;
import com.huaweicloud.dws.client.model.TableName;
import com.huaweicloud.dws.client.model.TableSchema;
import com.huaweicloud.dws.client.op.Delete;
import com.huaweicloud.dws.client.op.Operate;
import com.huaweicloud.dws.client.op.Write;
import com.huaweicloud.dws.client.util.AssertUtil;
import com.huaweicloud.dws.client.util.CacheUtil;
import com.huaweicloud.dws.client.util.LogUtil;
import com.huaweicloud.dws.client.worker.ExecutionPool;
import lombok.extern.slf4j.Slf4j;

import java.io.Closeable;
import java.io.IOException;
import java.sql.Connection;

/**
 * @ProjectName: dws-connector
 * @ClassName: DwsClient
 * @Description: 提供通用、便捷、高性能的入库能力
 * @Date: 2022/12/22 11:15
 * @Version: 1.0
 */
@Slf4j
public class DwsClient implements Closeable {

    /**
     * 事件收集器
     */
    private final ActionCollector collector;

    /**
     * 资源池
     */
    private final ExecutionPool pool;

    /**
     * 缓存工具
     */
    private final CacheUtil cacheUtil;

    private final DwsConfig config;

    /**
     * 初始化client
     * @param config 配置参数
     * @throws InvalidException 配置无效时抛出参数无效异常
     */
    public DwsClient(DwsConfig config) {
        AssertUtil.nonNull(config, new InvalidException("config is null"));
        this.pool = new ExecutionPool("dwsClient", config, this);
        collector = this.pool.getCollector();
        this.config = config;
        this.cacheUtil = new CacheUtil(config, this);
    }

    public DwsConfig getConfig() {
        return config;
    }

    /**
     * 原生sql执行
     */
    public  T sql(SqlExceptionFunction func) throws DwsClientException {
        SqlAction action = new SqlAction<>(func, config);
        while (!pool.submit(action)) {
            LogUtil.withLogSwitch(config, () -> log.warn("try submit."));
        }
        return action.getResult();
    }

    /**
     *
     * 获取表结构定义
     */
    public TableSchema getTableSchema(TableName tableName) throws DwsClientException {
        AssertUtil.nonNull(tableName, new InvalidException("tableName is null"));
        return cacheUtil.getTableSchema(tableName);
    }

    /**
     *
     * 根据表名开启一个写入数据API（如果非默认schema需要带表名全称 schema.name）
     * @deprecated 写入方式增加了update模式，为避免歧义统一使用{@link DwsClient#write(java.lang.String)}
     */
    @Deprecated
    public Operate upsert(String tableName) throws DwsClientException {
        TableName name = TableName.valueOf(tableName);
        return write(name);
    }

    /**
     * @deprecated {@link DwsClient#write(TableName)}
     */
    @Deprecated
    public Operate upsert(TableName tableName) throws DwsClientException {
        TableSchema tableSchema = getTableSchema(tableName);
        return write(tableSchema);
    }

    /**
     * @deprecated {@link DwsClient#write(TableSchema)}
     */
    @Deprecated
    public Operate upsert(TableSchema schema) {
        return write(schema);
    }

    public Operate write(String tableName) throws DwsClientException {
        TableName name = TableName.valueOf(tableName);
        return write(name);
    }

    public Operate write(TableName tableName) throws DwsClientException {
        TableSchema tableSchema = getTableSchema(tableName);
        return write(tableSchema);
    }

    public Operate write(TableSchema schema) {
        return new Write(schema, this.collector);
    }

    /**
     *
     * 根据表名开启一个删除数据API（如果非默认schema需要带表名全称 schema.name）
     */
    public Operate delete(String tableName) throws DwsClientException {
        TableName name = TableName.valueOf(tableName);
        return delete(name);
    }

    public Operate delete(TableName tableName) throws DwsClientException {
        TableSchema tableSchema = getTableSchema(tableName);
        return delete(tableSchema);
    }

    public Operate delete(TableSchema schema) {
        return new Delete(schema, this.collector);
    }


    /**
     *  将缓存数据强制刷入数据库
     */
    public void flush() throws DwsClientException {
        collector.flush();
    }


    /**
     *
     * 关闭client
     * 1、关闭新数据写入能力
     * 2、刷缓存数据入库
     * 3、释放client开辟资源
     */
    @Override
    public void close() throws IOException {
        Exception exception = null;
        // 先将本地缓存刷库
        try {
            flush();
        } catch (Exception e) {
            log.error("dws client close error", e);
            exception = e;
        }
        // 关闭资源
        pool.close();
        AssertUtil.isNull(exception, new IOException(exception));
    }
}