clickhouse-mcp/dist/config.d.ts

An MCP server for ClickHouse in TypeScript

/**
 * Configuration for ClickHouse connection settings.
 *
 * This interface handles all environment variable configuration with sensible defaults
 * and type conversion.
 *
 * Required environment variables:
 *   CLICKHOUSE_HOST: The hostname of the ClickHouse server
 *   CLICKHOUSE_USER: The username for authentication
 *   CLICKHOUSE_PASSWORD: The password for authentication
 *
 * Optional environment variables (with defaults):
 *   CLICKHOUSE_PORT: The port number (default: 8443 if secure=true, 8123 if secure=false)
 *   CLICKHOUSE_SECURE: Enable HTTPS (default: true)
 *   CLICKHOUSE_VERIFY: Verify SSL certificates (default: true)
 *   CLICKHOUSE_CONNECT_TIMEOUT: Connection timeout in seconds (default: 30)
 *   CLICKHOUSE_SEND_RECEIVE_TIMEOUT: Send/receive timeout in seconds (default: 300)
 *   CLICKHOUSE_DATABASE: Default database to use (default: undefined)
 */
export interface ClickHouseConfig {
    host: string;
    port: number;
    username: string;
    password: string;
    database?: string;
    secure: boolean;
    verify: boolean;
    connect_timeout: number;
    send_receive_timeout: number;
    client_name: string;
}
/**
 * Get the configuration object for the ClickHouse client.
 *
 * @returns ClickHouse client configuration
 */
export declare function getClientConfig(): ClickHouseConfig;
export declare const config: {
    getClientConfig: typeof getClientConfig;
};
export default config;
//# sourceMappingURL=config.d.ts.map