Discover modules > github.com/perses/shared/cue > common > proxy
v0.54.0-beta.8
#HTTPAllowedEndpoint: ¶
endpointPattern: string ¶
method: "POST" | "PUT" | "PATCH" | "GET" | "DELETE" ¶
#HTTPProxy: ¶
kind: "HTTPProxy" ¶
spec: ¶
url: common.#URL ¶

url is the url of the datasource. It is not the url of the proxy. The Perses server is the proxy, so it needs to know where to redirect the request.

allowedEndpoints?: [...#AllowedEndpoint] ¶

allowedEndpoints is a list of tuples of http methods and http endpoints that will be accessible. Leave it empty if you don't want to restrict the access to the datasource.

headers?: [string]: string ¶

headers can be used to provide additional headers that need to be forwarded when requesting the datasource

secret?: string ¶

secret is the name of the secret that should be used for the proxy or discovery configuration It will contain any sensitive information such as password, token, certificate.

#baseHTTPDatasourceSpec: datasource.#HTTPDatasourceSpec ¶
#MySQL: ¶
params?: [string]: string ¶
maxAllowedPacket?: int ¶
timeout?: common.#DurationString ¶
readTimeout?: common.#DurationString ¶
writeTimeout?: common.#DurationString ¶
#Postgres: ¶
options?: string ¶

options specifies command-line options to send to the server at connection start

max_conns?: number ¶

max_conns is the maximum size of the pool

connect_timeout?: common.#DurationString ¶

connect_timeout the timeout value used for socket connect operations.

prepare_threshold?: number ¶

prepare_threshold specifies the number of PreparedStatement executions that must occur before the driver begins using server-side prepared statements.

ssl_mode?: #enumSSLMode ¶

ssl_mode to use when connecting to postgres

#SQLProxy: ¶
kind: "SQLProxy" ¶
spec: ¶
driver: "mysql" | "postgres" | "mariadb" ¶
host: string ¶

host is the hostname and port of the datasource. It is not the hostname of the proxy. The Perses server is the proxy, so it needs to know where to redirect the request.

database: string ¶

database is the name of the database to connect to

secret?: string ¶

secret is the name of the secret that should be used for the proxy or discovery configuration It will contain any sensitive information such as username, password, token, certificate.

mysql?: ¶

mysql specific driver configurations

params?: [string]: string ¶
maxAllowedPacket?: int ¶
timeout?: common.#DurationString ¶
readTimeout?: common.#DurationString ¶
writeTimeout?: common.#DurationString ¶
postgres?: ¶

postgres specific driver configurations

options?: string ¶

options specifies command-line options to send to the server at connection start

max_conns?: number ¶

max_conns is the maximum size of the pool

connect_timeout?: common.#DurationString ¶

connect_timeout the timeout value used for socket connect operations.

prepare_threshold?: number ¶

prepare_threshold specifies the number of PreparedStatement executions that must occur before the driver begins using server-side prepared statements.

ssl_mode?: #enumSSLMode ¶

ssl_mode to use when connecting to postgres

#baseSQLDatasourceSpec: ¶
proxy: ¶
kind: "SQLProxy" ¶
spec: ¶
driver: "mysql" | "postgres" | "mariadb" ¶
host: string ¶

host is the hostname and port of the datasource. It is not the hostname of the proxy. The Perses server is the proxy, so it needs to know where to redirect the request.

database: string ¶

database is the name of the database to connect to

secret?: string ¶

secret is the name of the secret that should be used for the proxy or discovery configuration It will contain any sensitive information such as username, password, token, certificate.

mysql?: ¶

mysql specific driver configurations

params?: [string]: string ¶
maxAllowedPacket?: int ¶
timeout?: common.#DurationString ¶
readTimeout?: common.#DurationString ¶
writeTimeout?: common.#DurationString ¶
postgres?: ¶

postgres specific driver configurations

options?: string ¶

options specifies command-line options to send to the server at connection start

max_conns?: number ¶

max_conns is the maximum size of the pool

connect_timeout?: common.#DurationString ¶

connect_timeout the timeout value used for socket connect operations.

prepare_threshold?: number ¶

prepare_threshold specifies the number of PreparedStatement executions that must occur before the driver begins using server-side prepared statements.

ssl_mode?: #enumSSLMode ¶

ssl_mode to use when connecting to postgres

Source files

  • proxy.cue