clickhouse-java/client-v2/src/main/java/com/clickhouse/client/api/http/ClickHouseHttpProto.java at 7ae5f161052d20623684e3dbf6f1399df4398242 · ClickHouse/clickhouse-java · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
package com.clickhouse.client.api.http;

public class ClickHouseHttpProto {


    public static final String HEADER_SRV_DISPLAY_NAME = "X-ClickHouse-Server-Display-Name";

    /**
     * Response only header to indicate a query id
     * Cannot be used in request.
     */
    public static final String HEADER_QUERY_ID = "X-ClickHouse-Query-Id";

    public static final String HEADER_SRV_SUMMARY = "X-ClickHouse-Summary";

    /**
     * Response only header to indicate the format of the data.
     * Cannot be used in request.
     */
    public static final String HEADER_FORMAT = "X-ClickHouse-Format";

    public static final String HEADER_TIMEZONE = "X-ClickHouse-Timezone";

    /**
     * Response only header to indicate the error code.
     * Cannot be used in request.
     */
    public static final String HEADER_EXCEPTION_CODE = "X-ClickHouse-Exception-Code";

    /**
     * Response only header to indicate a query progress.
     * Cannot be used in request.
     */
    public static final String HEADER_PROGRESS = "X-ClickHouse-Progress";


    /**
     * Name of default database to be used if not specified in a table name.
     */
    public static final String HEADER_DATABASE = "X-ClickHouse-Database";

    /**
     * Name of user to be used to authenticate
     */
    public static final String HEADER_DB_USER = "X-ClickHouse-User";

    /**
     * Password of user to be used to authenticate. Note: header value should be unencoded, so using
     * special characters might cause issues. It is recommended to use the Basic Authentication instead.
     */
    public static final String HEADER_DB_PASSWORD = "X-ClickHouse-Key";

    public static final String HEADER_SSL_CERT_AUTH = "x-clickhouse-ssl-certificate-auth";

    /**
     * Query parameter to specify the query ID.
     */
    public static final String QPARAM_QUERY_ID = "query_id";

    /**
     * Query parameter to specify a session id.
     */
    public static final String QPARAM_SESSION_ID = "session_id";

    /**
     * Query parameter to check session status (1/0).
     */
    public static final String QPARAM_SESSION_CHECK = "session_check";

    /**
     * Query parameter to specify session timeout in seconds.
     */
    public static final String QPARAM_SESSION_TIMEOUT = "session_timeout";

    /**
     * Query parameter to specify session timezone.
     */
    public static final String QPARAM_SESSION_TIMEZONE = "session_timezone";

    public static final String QPARAM_ROLE = "role";

    /**
     * Query statement string ( ex. {@code INSERT INTO mytable }
     */
    public static final String QPARAM_QUERY_STMT = "query";

    public static final int DEFAULT_HTTP_PORT = 8123;

    public static final int DEFAULT_HTTPS_PORT = 8443;
}