import * as outputs from "../types/output";
export interface ClusterScheduling {
/**
* Configuration for refreshing the cluster.
*/
onRefresh?: outputs.ClusterSchedulingOnRefresh;
}
export interface ClusterSchedulingOnRefresh {
/**
* Enable scheduling to refresh the cluster.
*/
enabled?: boolean;
/**
* Estimated time to hydrate the cluster during refresh.
*/
hydrationTimeEstimate?: string;
/**
* Estimated time to rehydrate the cluster during refresh. This field is deprecated and will be removed in a future release. Use `hydration_time_estimate` instead.
*
* @deprecated Deprecated
*/
rehydrationTimeEstimate?: string;
}
export interface ClusterWaitUntilReady {
/**
* Enable wait_until_ready.
*/
enabled?: boolean;
/**
* Action to take on timeout: COMMIT|ROLLBACK
*/
onTimeout?: string;
/**
* Max duration to wait for the new replicas to be ready.
*/
timeout?: string;
}
export interface ConnectionAwsAccessKeyId {
/**
* The `access_key_id` secret value. Conflicts with `text` within this block.
*/
secret?: outputs.ConnectionAwsAccessKeyIdSecret;
/**
* The `access_key_id` text value. Conflicts with `secret` within this block
*/
text?: string;
}
export interface ConnectionAwsAccessKeyIdSecret {
/**
* The access_key_id database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The access_key_id name.
*/
name: string;
/**
* The access_key_id schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionAwsSecretAccessKey {
/**
* The secret_access_key database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The secret_access_key name.
*/
name: string;
/**
* The secret_access_key schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionAwsSessionToken {
/**
* The `session_token` secret value. Conflicts with `text` within this block.
*/
secret?: outputs.ConnectionAwsSessionTokenSecret;
/**
* The `session_token` text value. Conflicts with `secret` within this block
*/
text?: string;
}
export interface ConnectionAwsSessionTokenSecret {
/**
* The session_token database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The session_token name.
*/
name: string;
/**
* The session_token schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionConfluentSchemaRegistryAwsPrivatelink {
/**
* The aws_privatelink database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The aws_privatelink name.
*/
name: string;
/**
* The aws_privatelink schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionConfluentSchemaRegistryPassword {
/**
* The password database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The password name.
*/
name: string;
/**
* The password schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionConfluentSchemaRegistrySshTunnel {
/**
* The ssh_tunnel database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The ssh_tunnel name.
*/
name: string;
/**
* The ssh_tunnel schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionConfluentSchemaRegistrySslCertificate {
/**
* The `ssl_certificate` secret value. Conflicts with `text` within this block.
*/
secret?: outputs.ConnectionConfluentSchemaRegistrySslCertificateSecret;
/**
* The `ssl_certificate` text value. Conflicts with `secret` within this block
*/
text?: string;
}
export interface ConnectionConfluentSchemaRegistrySslCertificateAuthority {
/**
* The `ssl_certificate_authority` secret value. Conflicts with `text` within this block.
*/
secret?: outputs.ConnectionConfluentSchemaRegistrySslCertificateAuthoritySecret;
/**
* The `ssl_certificate_authority` text value. Conflicts with `secret` within this block
*/
text?: string;
}
export interface ConnectionConfluentSchemaRegistrySslCertificateAuthoritySecret {
/**
* The ssl_certificate_authority database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The ssl_certificate_authority name.
*/
name: string;
/**
* The ssl_certificate_authority schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionConfluentSchemaRegistrySslCertificateSecret {
/**
* The ssl_certificate database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The ssl_certificate name.
*/
name: string;
/**
* The ssl_certificate schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionConfluentSchemaRegistrySslKey {
/**
* The ssl_key database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The ssl_key name.
*/
name: string;
/**
* The ssl_key schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionConfluentSchemaRegistryUsername {
/**
* The `username` secret value. Conflicts with `text` within this block.
*/
secret?: outputs.ConnectionConfluentSchemaRegistryUsernameSecret;
/**
* The `username` text value. Conflicts with `secret` within this block
*/
text?: string;
}
export interface ConnectionConfluentSchemaRegistryUsernameSecret {
/**
* The username database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The username name.
*/
name: string;
/**
* The username schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionKafkaAwsConnection {
/**
* The aws_connection database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The aws_connection name.
*/
name: string;
/**
* The aws_connection schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionKafkaAwsPrivatelink {
/**
* The AWS PrivateLink connection name in Materialize.
*/
privatelinkConnection: outputs.ConnectionKafkaAwsPrivatelinkPrivatelinkConnection;
/**
* The port of the AWS PrivateLink connection.
*/
privatelinkConnectionPort: number;
}
export interface ConnectionKafkaAwsPrivatelinkPrivatelinkConnection {
/**
* The privatelink_connection database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The privatelink_connection name.
*/
name: string;
/**
* The privatelink_connection schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionKafkaKafkaBroker {
/**
* The availability zone of the Kafka broker.
*/
availabilityZone?: string;
/**
* The Kafka broker, in the form of `host:port`.
*/
broker: string;
/**
* The AWS PrivateLink connection name in Materialize.
*/
privatelinkConnection?: outputs.ConnectionKafkaKafkaBrokerPrivatelinkConnection;
/**
* The name of an SSH tunnel connection to route network traffic through by default.
*/
sshTunnel?: outputs.ConnectionKafkaKafkaBrokerSshTunnel;
/**
* The port of the target group associated with the Kafka broker.
*/
targetGroupPort?: number;
}
export interface ConnectionKafkaKafkaBrokerPrivatelinkConnection {
/**
* The privatelink_connection database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The privatelink_connection name.
*/
name: string;
/**
* The privatelink_connection schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionKafkaKafkaBrokerSshTunnel {
/**
* The ssh_tunnel database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The ssh_tunnel name.
*/
name: string;
/**
* The ssh_tunnel schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionKafkaSaslPassword {
/**
* The sasl_password database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The sasl_password name.
*/
name: string;
/**
* The sasl_password schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionKafkaSaslUsername {
/**
* The `sasl_username` secret value. Conflicts with `text` within this block.
*/
secret?: outputs.ConnectionKafkaSaslUsernameSecret;
/**
* The `sasl_username` text value. Conflicts with `secret` within this block
*/
text?: string;
}
export interface ConnectionKafkaSaslUsernameSecret {
/**
* The sasl_username database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The sasl_username name.
*/
name: string;
/**
* The sasl_username schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionKafkaSshTunnel {
/**
* The ssh_tunnel database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The ssh_tunnel name.
*/
name: string;
/**
* The ssh_tunnel schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionKafkaSslCertificate {
/**
* The `ssl_certificate` secret value. Conflicts with `text` within this block.
*/
secret?: outputs.ConnectionKafkaSslCertificateSecret;
/**
* The `ssl_certificate` text value. Conflicts with `secret` within this block
*/
text?: string;
}
export interface ConnectionKafkaSslCertificateAuthority {
/**
* The `ssl_certificate_authority` secret value. Conflicts with `text` within this block.
*/
secret?: outputs.ConnectionKafkaSslCertificateAuthoritySecret;
/**
* The `ssl_certificate_authority` text value. Conflicts with `secret` within this block
*/
text?: string;
}
export interface ConnectionKafkaSslCertificateAuthoritySecret {
/**
* The ssl_certificate_authority database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The ssl_certificate_authority name.
*/
name: string;
/**
* The ssl_certificate_authority schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionKafkaSslCertificateSecret {
/**
* The ssl_certificate database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The ssl_certificate name.
*/
name: string;
/**
* The ssl_certificate schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionKafkaSslKey {
/**
* The ssl_key database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The ssl_key name.
*/
name: string;
/**
* The ssl_key schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionMysqlAwsPrivatelink {
/**
* The aws_privatelink database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The aws_privatelink name.
*/
name: string;
/**
* The aws_privatelink schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionMysqlPassword {
/**
* The password database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The password name.
*/
name: string;
/**
* The password schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionMysqlSshTunnel {
/**
* The ssh_tunnel database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The ssh_tunnel name.
*/
name: string;
/**
* The ssh_tunnel schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionMysqlSslCertificate {
/**
* The `ssl_certificate` secret value. Conflicts with `text` within this block.
*/
secret?: outputs.ConnectionMysqlSslCertificateSecret;
/**
* The `ssl_certificate` text value. Conflicts with `secret` within this block
*/
text?: string;
}
export interface ConnectionMysqlSslCertificateAuthority {
/**
* The `ssl_certificate_authority` secret value. Conflicts with `text` within this block.
*/
secret?: outputs.ConnectionMysqlSslCertificateAuthoritySecret;
/**
* The `ssl_certificate_authority` text value. Conflicts with `secret` within this block
*/
text?: string;
}
export interface ConnectionMysqlSslCertificateAuthoritySecret {
/**
* The ssl_certificate_authority database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The ssl_certificate_authority name.
*/
name: string;
/**
* The ssl_certificate_authority schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionMysqlSslCertificateSecret {
/**
* The ssl_certificate database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The ssl_certificate name.
*/
name: string;
/**
* The ssl_certificate schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionMysqlSslKey {
/**
* The ssl_key database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The ssl_key name.
*/
name: string;
/**
* The ssl_key schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionMysqlUser {
/**
* The `user` secret value. Conflicts with `text` within this block.
*/
secret?: outputs.ConnectionMysqlUserSecret;
/**
* The `user` text value. Conflicts with `secret` within this block
*/
text?: string;
}
export interface ConnectionMysqlUserSecret {
/**
* The user database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The user name.
*/
name: string;
/**
* The user schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionPostgresAwsPrivatelink {
/**
* The aws_privatelink database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The aws_privatelink name.
*/
name: string;
/**
* The aws_privatelink schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionPostgresPassword {
/**
* The password database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The password name.
*/
name: string;
/**
* The password schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionPostgresSshTunnel {
/**
* The ssh_tunnel database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The ssh_tunnel name.
*/
name: string;
/**
* The ssh_tunnel schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionPostgresSslCertificate {
/**
* The `ssl_certificate` secret value. Conflicts with `text` within this block.
*/
secret?: outputs.ConnectionPostgresSslCertificateSecret;
/**
* The `ssl_certificate` text value. Conflicts with `secret` within this block
*/
text?: string;
}
export interface ConnectionPostgresSslCertificateAuthority {
/**
* The `ssl_certificate_authority` secret value. Conflicts with `text` within this block.
*/
secret?: outputs.ConnectionPostgresSslCertificateAuthoritySecret;
/**
* The `ssl_certificate_authority` text value. Conflicts with `secret` within this block
*/
text?: string;
}
export interface ConnectionPostgresSslCertificateAuthoritySecret {
/**
* The ssl_certificate_authority database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The ssl_certificate_authority name.
*/
name: string;
/**
* The ssl_certificate_authority schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionPostgresSslCertificateSecret {
/**
* The ssl_certificate database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The ssl_certificate name.
*/
name: string;
/**
* The ssl_certificate schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionPostgresSslKey {
/**
* The ssl_key database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The ssl_key name.
*/
name: string;
/**
* The ssl_key schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionPostgresUser {
/**
* The `user` secret value. Conflicts with `text` within this block.
*/
secret?: outputs.ConnectionPostgresUserSecret;
/**
* The `user` text value. Conflicts with `secret` within this block
*/
text?: string;
}
export interface ConnectionPostgresUserSecret {
/**
* The user database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The user name.
*/
name: string;
/**
* The user schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionSqlserverAwsPrivatelink {
/**
* The aws_privatelink database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The aws_privatelink name.
*/
name: string;
/**
* The aws_privatelink schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionSqlserverPassword {
/**
* The password database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The password name.
*/
name: string;
/**
* The password schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionSqlserverSshTunnel {
/**
* The ssh_tunnel database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The ssh_tunnel name.
*/
name: string;
/**
* The ssh_tunnel schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionSqlserverSslCertificateAuthority {
/**
* The `ssl_certificate_authority` secret value. Conflicts with `text` within this block.
*/
secret?: outputs.ConnectionSqlserverSslCertificateAuthoritySecret;
/**
* The `ssl_certificate_authority` text value. Conflicts with `secret` within this block
*/
text?: string;
}
export interface ConnectionSqlserverSslCertificateAuthoritySecret {
/**
* The ssl_certificate_authority database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The ssl_certificate_authority name.
*/
name: string;
/**
* The ssl_certificate_authority schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface ConnectionSqlserverUser {
/**
* The `user` secret value. Conflicts with `text` within this block.
*/
secret?: outputs.ConnectionSqlserverUserSecret;
/**
* The `user` text value. Conflicts with `secret` within this block
*/
text?: string;
}
export interface ConnectionSqlserverUserSecret {
/**
* The user database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The user name.
*/
name: string;
/**
* The user schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface GetClusterCluster {
disk: boolean;
id: string;
managed: boolean;
name: string;
replicationFactor: number;
size: string;
}
export interface GetClusterReplicaClusterReplica {
availabilityZone: string;
cluster: string;
disk: boolean;
id: string;
name: string;
size: string;
}
export interface GetConnectionConnection {
databaseName: string;
id: string;
name: string;
schemaName: string;
type: string;
}
export interface GetDatabaseDatabase {
id: string;
name: string;
}
export interface GetIndexIndex {
id: string;
name: string;
objDatabase: string;
objName: string;
objSchema: string;
}
export interface GetMaterializedViewMaterializedView {
databaseName: string;
id: string;
name: string;
schemaName: string;
}
export interface GetNetworkPolicyNetworkPolicy {
comment: string;
id: string;
name: string;
rules: outputs.GetNetworkPolicyNetworkPolicyRule[];
}
export interface GetNetworkPolicyNetworkPolicyRule {
action: string;
address: string;
direction: string;
name: string;
}
export interface GetRegionRegion {
cloudProvider: string;
host: string;
id: string;
name: string;
url: string;
}
export interface GetRoleRole {
id: string;
name: string;
}
export interface GetSchemaSchema {
databaseName: string;
id: string;
name: string;
}
export interface GetScimConfigsConfiguration {
connectionName: string;
createdAt: string;
id: string;
source: string;
syncToUserManagement: boolean;
tenantId: string;
}
export interface GetScimGroupsGroup {
description: string;
id: string;
managedBy: string;
metadata: string;
name: string;
roles: outputs.GetScimGroupsGroupRole[];
users: outputs.GetScimGroupsGroupUser[];
}
export interface GetScimGroupsGroupRole {
description: string;
id: string;
isDefault: boolean;
key: string;
name: string;
}
export interface GetScimGroupsGroupUser {
email: string;
id: string;
name: string;
}
export interface GetSecretSecret {
databaseName: string;
id: string;
name: string;
schemaName: string;
}
export interface GetSinkSink {
clusterName: string;
connectionName: string;
databaseName: string;
envelopeType: string;
id: string;
name: string;
schemaName: string;
size: string;
type: string;
}
export interface GetSourceSource {
clusterName: string;
connectionName: string;
databaseName: string;
envelopeType: string;
id: string;
name: string;
schemaName: string;
size: string;
type: string;
}
export interface GetSsoConfigSsoConfig {
domains: outputs.GetSsoConfigSsoConfigDomain[];
enabled: boolean;
groups: outputs.GetSsoConfigSsoConfigGroup[];
id: string;
oidcClientId: string;
oidcSecret: string;
publicCertificate: string;
roleIds: string[];
signRequest: boolean;
ssoEndpoint: string;
type: string;
}
export interface GetSsoConfigSsoConfigDomain {
domain: string;
id: string;
validated: boolean;
}
export interface GetSsoConfigSsoConfigGroup {
enabled: boolean;
group: string;
id: string;
roleIds: string[];
}
export interface GetSystemParameterParameter {
description: string;
name: string;
setting: string;
}
export interface GetTableTable {
databaseName: string;
id: string;
name: string;
schemaName: string;
}
export interface GetTypeType {
category: string;
databaseName: string;
id: string;
name: string;
schemaName: string;
}
export interface GetViewView {
databaseName: string;
id: string;
name: string;
schemaName: string;
}
export interface IndexColExpr {
/**
* The name of the option you want to set.
*/
field: string;
}
export interface IndexObjName {
/**
* The obj_name database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The obj_name name.
*/
name: string;
/**
* The obj_name schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface NetworkPolicyRule {
/**
* The action to take for this rule. Currently only 'allow' is supported.
*/
action: string;
/**
* The CIDR block the rule will be applied to.
*/
address: string;
/**
* The direction of traffic the rule applies to. Currently only 'ingress' is supported.
*/
direction: string;
/**
* The name of the rule.
*/
name: string;
}
export interface SinkKafkaEnvelope {
/**
* The generated schemas have a Debezium-style diff envelope to capture changes in the input view or source.
*/
debezium?: boolean;
/**
* The sink emits data with upsert semantics: updates and inserts for the given key are expressed as a value, and deletes are expressed as a null value payload in Kafka.
*/
upsert?: boolean;
}
export interface SinkKafkaFormat {
/**
* Avro format.
*/
avro?: outputs.SinkKafkaFormatAvro;
/**
* JSON format.
*/
json?: boolean;
}
export interface SinkKafkaFormatAvro {
/**
* Add column level documentation comment to the generated Avro schemas.
*/
avroDocColumns?: outputs.SinkKafkaFormatAvroAvroDocColumn[];
/**
* Add top level documentation comment to the generated Avro schemas.
*/
avroDocType?: outputs.SinkKafkaFormatAvroAvroDocType;
/**
* The full name of the Avro key schema.
*/
avroKeyFullname?: string;
/**
* The full name of the Avro value schema.
*/
avroValueFullname?: string;
/**
* If specified, set the Compatibility Level for the generated key schema.
*/
keyCompatibilityLevel?: string;
/**
* The name of a schema registry connection.
*/
schemaRegistryConnection: outputs.SinkKafkaFormatAvroSchemaRegistryConnection;
/**
* If specified, set the Compatibility Level for the generated value schema.
*/
valueCompatibilityLevel?: string;
}
export interface SinkKafkaFormatAvroAvroDocColumn {
/**
* Name of the column in the Avro schema to apply to.
*/
column: string;
/**
* Documentation string.
*/
doc: string;
/**
* Applies to the key schema.
*/
key?: boolean;
/**
* The object to apply the Avro documentation.
*/
object: outputs.SinkKafkaFormatAvroAvroDocColumnObject;
/**
* Applies to the value schema.
*/
value?: boolean;
}
export interface SinkKafkaFormatAvroAvroDocColumnObject {
/**
* The object database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The object name.
*/
name: string;
/**
* The object schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface SinkKafkaFormatAvroAvroDocType {
/**
* Documentation string.
*/
doc: string;
/**
* Applies to the key schema.
*/
key?: boolean;
/**
* The object to apply the Avro documentation.
*/
object: outputs.SinkKafkaFormatAvroAvroDocTypeObject;
/**
* Applies to the value schema.
*/
value?: boolean;
}
export interface SinkKafkaFormatAvroAvroDocTypeObject {
/**
* The object database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The object name.
*/
name: string;
/**
* The object schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface SinkKafkaFormatAvroSchemaRegistryConnection {
/**
* The schema_registry_connection database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The schema_registry_connection name.
*/
name: string;
/**
* The schema_registry_connection schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface SinkKafkaFrom {
/**
* The from database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The from name.
*/
name: string;
/**
* The from schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface SinkKafkaKafkaConnection {
/**
* The kafka_connection database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The kafka_connection name.
*/
name: string;
/**
* The kafka_connection schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface SourceKafkaEnvelope {
/**
* Use the Debezium envelope, which uses a diff envelope to handle CRUD operations.
*/
debezium?: boolean;
/**
* Use an append-only envelope. This means that records will only be appended and cannot be updated or deleted.
*/
none?: boolean;
/**
* Use the upsert envelope, which uses message keys to handle CRUD operations.
*/
upsert?: boolean;
/**
* Options for the upsert envelope.
*/
upsertOptions?: outputs.SourceKafkaEnvelopeUpsertOptions;
}
export interface SourceKafkaEnvelopeUpsertOptions {
/**
* Specify how to handle value decoding errors in the upsert envelope.
*/
valueDecodingErrors?: outputs.SourceKafkaEnvelopeUpsertOptionsValueDecodingErrors;
}
export interface SourceKafkaEnvelopeUpsertOptionsValueDecodingErrors {
/**
* Configuration for inline value decoding errors.
*/
inline?: outputs.SourceKafkaEnvelopeUpsertOptionsValueDecodingErrorsInline;
}
export interface SourceKafkaEnvelopeUpsertOptionsValueDecodingErrorsInline {
/**
* Specify an alias for the value decoding errors column, to use an alternative name for the error column. If not specified, the column name will be `error`.
*/
alias?: string;
/**
* Enable inline value decoding errors.
*/
enabled?: boolean;
}
export interface SourceKafkaExposeProgress {
/**
* The expose_progress database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The expose_progress name.
*/
name: string;
/**
* The expose_progress schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface SourceKafkaFormat {
/**
* Avro format.
*/
avro?: outputs.SourceKafkaFormatAvro;
/**
* BYTES format.
*/
bytes?: boolean;
/**
* CSV format.
*/
csvs?: outputs.SourceKafkaFormatCsv[];
/**
* JSON format.
*/
json?: boolean;
/**
* Protobuf format.
*/
protobuf?: outputs.SourceKafkaFormatProtobuf;
/**
* Text format.
*/
text?: boolean;
}
export interface SourceKafkaFormatAvro {
/**
* How Materialize will define the Avro schema reader key strategy.
*/
keyStrategy?: string;
/**
* The name of a schema registry connection.
*/
schemaRegistryConnection: outputs.SourceKafkaFormatAvroSchemaRegistryConnection;
/**
* How Materialize will define the Avro schema reader value strategy.
*/
valueStrategy?: string;
}
export interface SourceKafkaFormatAvroSchemaRegistryConnection {
/**
* The schema_registry_connection database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The schema_registry_connection name.
*/
name: string;
/**
* The schema_registry_connection schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface SourceKafkaFormatCsv {
/**
* The columns to use for the source.
*/
column?: number;
/**
* The delimiter to use for the source.
*/
delimitedBy?: string;
/**
* The number of columns and the name of each column using the header row.
*/
headers?: string[];
}
export interface SourceKafkaFormatProtobuf {
/**
* The name of the Protobuf message to use for the source.
*/
message: string;
/**
* The name of a schema registry connection.
*/
schemaRegistryConnection: outputs.SourceKafkaFormatProtobufSchemaRegistryConnection;
}
export interface SourceKafkaFormatProtobufSchemaRegistryConnection {
/**
* The schema_registry_connection database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The schema_registry_connection name.
*/
name: string;
/**
* The schema_registry_connection schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface SourceKafkaKafkaConnection {
/**
* The kafka_connection database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The kafka_connection name.
*/
name: string;
/**
* The kafka_connection schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface SourceKafkaKeyFormat {
/**
* Avro format.
*/
avro?: outputs.SourceKafkaKeyFormatAvro;
/**
* BYTES format.
*/
bytes?: boolean;
/**
* CSV format.
*/
csvs?: outputs.SourceKafkaKeyFormatCsv[];
/**
* JSON format.
*/
json?: boolean;
/**
* Protobuf format.
*/
protobuf?: outputs.SourceKafkaKeyFormatProtobuf;
/**
* Text format.
*/
text?: boolean;
}
export interface SourceKafkaKeyFormatAvro {
/**
* How Materialize will define the Avro schema reader key strategy.
*/
keyStrategy?: string;
/**
* The name of a schema registry connection.
*/
schemaRegistryConnection: outputs.SourceKafkaKeyFormatAvroSchemaRegistryConnection;
/**
* How Materialize will define the Avro schema reader value strategy.
*/
valueStrategy?: string;
}
export interface SourceKafkaKeyFormatAvroSchemaRegistryConnection {
/**
* The schema_registry_connection database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The schema_registry_connection name.
*/
name: string;
/**
* The schema_registry_connection schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface SourceKafkaKeyFormatCsv {
/**
* The columns to use for the source.
*/
column?: number;
/**
* The delimiter to use for the source.
*/
delimitedBy?: string;
/**
* The number of columns and the name of each column using the header row.
*/
headers?: string[];
}
export interface SourceKafkaKeyFormatProtobuf {
/**
* The name of the Protobuf message to use for the source.
*/
message: string;
/**
* The name of a schema registry connection.
*/
schemaRegistryConnection: outputs.SourceKafkaKeyFormatProtobufSchemaRegistryConnection;
}
export interface SourceKafkaKeyFormatProtobufSchemaRegistryConnection {
/**
* The schema_registry_connection database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The schema_registry_connection name.
*/
name: string;
/**
* The schema_registry_connection schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface SourceKafkaValueFormat {
/**
* Avro format.
*/
avro?: outputs.SourceKafkaValueFormatAvro;
/**
* BYTES format.
*/
bytes?: boolean;
/**
* CSV format.
*/
csvs?: outputs.SourceKafkaValueFormatCsv[];
/**
* JSON format.
*/
json?: boolean;
/**
* Protobuf format.
*/
protobuf?: outputs.SourceKafkaValueFormatProtobuf;
/**
* Text format.
*/
text?: boolean;
}
export interface SourceKafkaValueFormatAvro {
/**
* How Materialize will define the Avro schema reader key strategy.
*/
keyStrategy?: string;
/**
* The name of a schema registry connection.
*/
schemaRegistryConnection: outputs.SourceKafkaValueFormatAvroSchemaRegistryConnection;
/**
* How Materialize will define the Avro schema reader value strategy.
*/
valueStrategy?: string;
}
export interface SourceKafkaValueFormatAvroSchemaRegistryConnection {
/**
* The schema_registry_connection database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The schema_registry_connection name.
*/
name: string;
/**
* The schema_registry_connection schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface SourceKafkaValueFormatCsv {
/**
* The columns to use for the source.
*/
column?: number;
/**
* The delimiter to use for the source.
*/
delimitedBy?: string;
/**
* The number of columns and the name of each column using the header row.
*/
headers?: string[];
}
export interface SourceKafkaValueFormatProtobuf {
/**
* The name of the Protobuf message to use for the source.
*/
message: string;
/**
* The name of a schema registry connection.
*/
schemaRegistryConnection: outputs.SourceKafkaValueFormatProtobufSchemaRegistryConnection;
}
export interface SourceKafkaValueFormatProtobufSchemaRegistryConnection {
/**
* The schema_registry_connection database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The schema_registry_connection name.
*/
name: string;
/**
* The schema_registry_connection schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface SourceLoadGeneratorAuctionOptions {
/**
* (Deprecated) The scale factor for the generator. Defaults to 0.01 (~ 10MB).
*
* @deprecated Deprecated
*/
scaleFactor?: number;
/**
* The interval at which the next datum should be emitted. Defaults to one second.
*/
tickInterval?: string;
}
export interface SourceLoadGeneratorExposeProgress {
/**
* The expose_progress database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The expose_progress name.
*/
name: string;
/**
* The expose_progress schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface SourceLoadGeneratorMarketingOptions {
/**
* (Deprecated) The scale factor for the generator. Defaults to 0.01 (~ 10MB).
*
* @deprecated Deprecated
*/
scaleFactor?: number;
/**
* The interval at which the next datum should be emitted. Defaults to one second.
*/
tickInterval?: string;
}
export interface SourceLoadGeneratorTpchOptions {
/**
* The scale factor for the generator. Defaults to 0.01 (~ 10MB).
*/
scaleFactor?: number;
/**
* The interval at which the next datum should be emitted. Defaults to one second.
*/
tickInterval?: string;
}
export interface SourceMysqlExposeProgress {
/**
* The expose_progress database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The expose_progress name.
*/
name: string;
/**
* The expose_progress schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface SourceMysqlMysqlConnection {
/**
* The mysql_connection database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The mysql_connection name.
*/
name: string;
/**
* The mysql_connection schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface SourceMysqlTable {
/**
* The database of the table in Materialize.
*/
databaseName: string;
/**
* The name for the table, used in Materialize.
*/
name: string;
/**
* The schema of the table in Materialize.
*/
schemaName: string;
/**
* The name of the table in the upstream MySQL database.
*/
upstreamName: string;
/**
* The schema of the table in the upstream MySQL database.
*/
upstreamSchemaName: string;
}
export interface SourcePostgresExposeProgress {
/**
* The expose_progress database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The expose_progress name.
*/
name: string;
/**
* The expose_progress schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface SourcePostgresPostgresConnection {
/**
* The postgres_connection database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The postgres_connection name.
*/
name: string;
/**
* The postgres_connection schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface SourcePostgresTable {
/**
* The database of the table in Materialize.
*/
databaseName: string;
/**
* The name of the table in Materialize.
*/
name: string;
/**
* The schema of the table in Materialize.
*/
schemaName: string;
/**
* The name of the table in the upstream Postgres database.
*/
upstreamName: string;
/**
* The schema of the table in the upstream Postgres database.
*/
upstreamSchemaName: string;
}
export interface SourceSqlserverAwsPrivatelink {
/**
* The aws_privatelink database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The aws_privatelink name.
*/
name: string;
/**
* The aws_privatelink schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface SourceSqlserverExposeProgress {
/**
* The expose_progress database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The expose_progress name.
*/
name: string;
/**
* The expose_progress schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface SourceSqlserverSqlserverConnection {
/**
* The sqlserver_connection database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The sqlserver_connection name.
*/
name: string;
/**
* The sqlserver_connection schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface SourceSqlserverTable {
/**
* The database of the table in Materialize.
*/
databaseName: string;
/**
* The name for the table, used in Materialize.
*/
name: string;
/**
* The schema of the table in Materialize.
*/
schemaName: string;
/**
* The name of the table in the upstream SQL Server database.
*/
upstreamName: string;
/**
* The schema of the table in the upstream SQL Server database.
*/
upstreamSchemaName: string;
}
export interface SourceWebhookCheckOption {
/**
* The alias for the check options.
*/
alias?: string;
/**
* Change type to `bytea`.
*/
bytes?: boolean;
/**
* The field for the check options.
*/
field: outputs.SourceWebhookCheckOptionField;
}
export interface SourceWebhookCheckOptionField {
/**
* The body for the check options.
*/
body?: boolean;
/**
* The headers for the check options.
*/
headers?: boolean;
/**
* The secret for the check options.
*/
secret?: outputs.SourceWebhookCheckOptionFieldSecret;
}
export interface SourceWebhookCheckOptionFieldSecret {
/**
* The secret database name. Defaults to `MZ_DATABASE` environment variable if set or `materialize` if environment variable is not set.
*/
databaseName?: string;
/**
* The secret name.
*/
name: string;
/**
* The secret schema name. Defaults to `public`.
*/
schemaName?: string;
}
export interface SourceWebhookIncludeHeader {
/**
* The alias for the header.
*/
alias?: string;
/**
* Change type to `bytea`.
*/
bytes?: boolean;
/**
* The name for the header.
*/
header: string;
}
export interface SourceWebhookIncludeHeaders {
/**
* Include all headers.
*/
all?: boolean;
/**
* Headers that should be excluded.
*/
nots?: string[];
/**
* Headers that should be included.
*/
onlies?: string[];
}
export interface TableColumn {
/**
* Comment on an object in the database.
*/
comment?: string;
/**
* A default value to use for the column in an INSERT statement if an explicit value is not provided. If not specified, `NULL` is assumed..
*/
default?: string;
/**
* The name of the column to be created in the table.
*/
name: string;
/**
* Do not allow the column to contain `NULL` values. Columns without this constraint can contain `NULL` values.
*/
nullable?: boolean;
/**
* The data type of the column indicated by name.
*/
type: string;
}
export interface TypeListProperties {
/**
* Creates a custom list whose elements are of `ELEMENT TYPE`
*/
elementType: string;
}
export interface TypeMapProperties {
/**
* Creates a custom map whose keys are of `KEY TYPE`. `KEY TYPE` must resolve to text.
*/
keyType: string;
/**
* Creates a custom map whose values are of `VALUE TYPE`.
*/
valueType: string;
}
export interface TypeRowProperty {
/**
* The name of a field in a row type.
*/
fieldName: string;
/**
* The data type of a field indicated by `FIELD NAME`.
*/
fieldType: string;
}