biglake library
BigLake Metastore — catalogs, databases, and tables (nested
hive_options config is passed as a structured map), Iceberg and
Hive catalogs, and their resource IAM.
Classes
-
AppConstant<
T> -
A value the Stack hands to application code as a
static constin the generated AppExports file — known when synth runs, so the app compiles against it. - AppExports
-
Where synth writes the Dart file application code imports: the Stack's
constants, as the
static constmembers of<name>Constants, and a typed reader of its Terraform outputs,<name>Outputs. -
AttributeRef<
T> -
Public for sealed pattern matching, but constructor is private — only
TfRef.attribute()may construct instances. - BiglakeDatabaseHiveOptions
-
Typed helper for the
hive_optionsblock ofgoogle_biglake_database(derived from provider schema). - BiglakeHiveCatalogIamBindingCondition
-
Typed helper for the
conditionblock ofgoogle_biglake_hive_catalog_iam_binding(derived from provider schema). - BiglakeHiveCatalogIamMemberCondition
-
Typed helper for the
conditionblock ofgoogle_biglake_hive_catalog_iam_member(derived from provider schema). - BiglakeHiveDatabaseIamBindingCondition
-
Typed helper for the
conditionblock ofgoogle_biglake_hive_database_iam_binding(derived from provider schema). - BiglakeHiveDatabaseIamMemberCondition
-
Typed helper for the
conditionblock ofgoogle_biglake_hive_database_iam_member(derived from provider schema). - BiglakeHiveTableColumns
-
Typed helper for the
storage_descriptor.columnsblock ofgoogle_biglake_hive_table(derived from provider schema). - BiglakeHiveTableIamBindingCondition
-
Typed helper for the
conditionblock ofgoogle_biglake_hive_table_iam_binding(derived from provider schema). - BiglakeHiveTableIamMemberCondition
-
Typed helper for the
conditionblock ofgoogle_biglake_hive_table_iam_member(derived from provider schema). - BiglakeHiveTablePartitionKeys
-
Typed helper for the
partition_keysblock ofgoogle_biglake_hive_table(derived from provider schema). - BiglakeHiveTableSerdeInfo
-
Typed helper for the
storage_descriptor.serde_infoblock ofgoogle_biglake_hive_table(derived from provider schema). - BiglakeHiveTableSkewedColValues
-
Typed helper for the
storage_descriptor.skewed_info.skewed_col_valuesblock ofgoogle_biglake_hive_table(derived from provider schema). - BiglakeHiveTableSkewedInfo
-
Typed helper for the
storage_descriptor.skewed_infoblock ofgoogle_biglake_hive_table(derived from provider schema). - BiglakeHiveTableSkewedKeyValuesLocations
-
Typed helper for the
storage_descriptor.skewed_info.skewed_key_values_locationsblock ofgoogle_biglake_hive_table(derived from provider schema). - BiglakeHiveTableSortCols
-
Typed helper for the
storage_descriptor.sort_colsblock ofgoogle_biglake_hive_table(derived from provider schema). - BiglakeHiveTableStorageDescriptor
-
Typed helper for the
storage_descriptorblock ofgoogle_biglake_hive_table(derived from provider schema). - BiglakeIcebergCatalogFederatedCatalogOptions
-
Typed helper for the
federated_catalog_optionsblock ofgoogle_biglake_iceberg_catalog(derived from provider schema). - BiglakeIcebergCatalogGlueCatalogInfo
-
Typed helper for the
federated_catalog_options.glue_catalog_infoblock ofgoogle_biglake_iceberg_catalog(derived from provider schema). - BiglakeIcebergCatalogIamBindingCondition
-
Typed helper for the
conditionblock ofgoogle_biglake_iceberg_catalog_iam_binding(derived from provider schema). - BiglakeIcebergCatalogIamMemberCondition
-
Typed helper for the
conditionblock ofgoogle_biglake_iceberg_catalog_iam_member(derived from provider schema). - BiglakeIcebergCatalogRefreshOptions
-
Typed helper for the
federated_catalog_options.refresh_optionsblock ofgoogle_biglake_iceberg_catalog(derived from provider schema). - BiglakeIcebergCatalogRefreshSchedule
-
Typed helper for the
federated_catalog_options.refresh_options.refresh_scheduleblock ofgoogle_biglake_iceberg_catalog(derived from provider schema). - BiglakeIcebergCatalogRefreshScope
-
Typed helper for the
federated_catalog_options.refresh_options.refresh_scopeblock ofgoogle_biglake_iceberg_catalog(derived from provider schema). - BiglakeIcebergCatalogRestrictedLocationsConfig
-
Typed helper for the
restricted_locations_configblock ofgoogle_biglake_iceberg_catalog(derived from provider schema). - BiglakeIcebergCatalogUnityCatalogInfo
-
Typed helper for the
federated_catalog_options.unity_catalog_infoblock ofgoogle_biglake_iceberg_catalog(derived from provider schema). - BiglakeIcebergNamespaceIamBindingCondition
-
Typed helper for the
conditionblock ofgoogle_biglake_iceberg_namespace_iam_binding(derived from provider schema). - BiglakeIcebergNamespaceIamMemberCondition
-
Typed helper for the
conditionblock ofgoogle_biglake_iceberg_namespace_iam_member(derived from provider schema). - BiglakeIcebergTableIamBindingCondition
-
Typed helper for the
conditionblock ofgoogle_biglake_iceberg_table_iam_binding(derived from provider schema). - BiglakeIcebergTableIamMemberCondition
-
Typed helper for the
conditionblock ofgoogle_biglake_iceberg_table_iam_member(derived from provider schema). - BiglakeIcebergTablePartitionSpec
-
Typed helper for the
partition_specblock ofgoogle_biglake_iceberg_table(derived from provider schema). - BiglakeIcebergTablePartitionSpecFields
-
Typed helper for the
partition_spec.fieldsblock ofgoogle_biglake_iceberg_table(derived from provider schema). - BiglakeIcebergTableSchema
-
Typed helper for the
schemablock ofgoogle_biglake_iceberg_table(derived from provider schema). - BiglakeIcebergTableSchemaFields
-
Typed helper for the
schema.fieldsblock ofgoogle_biglake_iceberg_table(derived from provider schema). - BiglakeIcebergTableSortOrder
-
Typed helper for the
sort_orderblock ofgoogle_biglake_iceberg_table(derived from provider schema). - BiglakeIcebergTableSortOrderFields
-
Typed helper for the
sort_order.fieldsblock ofgoogle_biglake_iceberg_table(derived from provider schema). - BiglakeTableHiveOptions
-
Typed helper for the
hive_optionsblock ofgoogle_biglake_table(derived from provider schema). - BiglakeTableSerdeInfo
-
Typed helper for the
hive_options.storage_descriptor.serde_infoblock ofgoogle_biglake_table(derived from provider schema). - BiglakeTableStorageDescriptor
-
Typed helper for the
hive_options.storage_descriptorblock ofgoogle_biglake_table(derived from provider schema). - DartDefineOutput
-
An
outputwhose value is the client build's--dart-definefile, registered withStack.addDartDefineOutput. - Data
-
Base of every user-instantiable Terraform
datablock. - DataGoogleBiglakeHiveCatalogIamPolicy
-
Factory wrapper for
google_biglake_hive_catalog_iam_policy. - DataGoogleBiglakeHiveDatabaseIamPolicy
-
Factory wrapper for
google_biglake_hive_database_iam_policy. - DataGoogleBiglakeHiveTableIamPolicy
-
Factory wrapper for
google_biglake_hive_table_iam_policy. - DataGoogleBiglakeIcebergCatalogIamPolicy
-
Factory wrapper for
google_biglake_iceberg_catalog_iam_policy. - DataGoogleBiglakeIcebergNamespaceIamPolicy
-
Factory wrapper for
google_biglake_iceberg_namespace_iam_policy. - DataGoogleBiglakeIcebergTableIamPolicy
-
Factory wrapper for
google_biglake_iceberg_table_iam_policy. -
DataRef<
T> -
Public for sealed pattern matching, but constructor is private — only
TfRef.data()may construct instances. - EnvironmentConstant
- The AppConstant.fromEnvironment choice.
- GcsBackend
-
terraform { backend "gcs" { ... } }configuration. - GoogleBiglakeCatalog
-
Factory wrapper for
google_biglake_catalog. - GoogleBiglakeDatabase
-
Factory wrapper for
google_biglake_database. - GoogleBiglakeHiveCatalog
-
Factory wrapper for
google_biglake_hive_catalog. - GoogleBiglakeHiveCatalogIamBinding
-
Factory wrapper for
google_biglake_hive_catalog_iam_binding. - GoogleBiglakeHiveCatalogIamMember
-
Factory wrapper for
google_biglake_hive_catalog_iam_member. - GoogleBiglakeHiveCatalogIamPolicy
-
Factory wrapper for
google_biglake_hive_catalog_iam_policy. - GoogleBiglakeHiveDatabase
-
Factory wrapper for
google_biglake_hive_database. - GoogleBiglakeHiveDatabaseIamBinding
-
Factory wrapper for
google_biglake_hive_database_iam_binding. - GoogleBiglakeHiveDatabaseIamMember
-
Factory wrapper for
google_biglake_hive_database_iam_member. - GoogleBiglakeHiveDatabaseIamPolicy
-
Factory wrapper for
google_biglake_hive_database_iam_policy. - GoogleBiglakeHiveTable
-
Factory wrapper for
google_biglake_hive_table. - GoogleBiglakeHiveTableIamBinding
-
Factory wrapper for
google_biglake_hive_table_iam_binding. - GoogleBiglakeHiveTableIamMember
-
Factory wrapper for
google_biglake_hive_table_iam_member. - GoogleBiglakeHiveTableIamPolicy
-
Factory wrapper for
google_biglake_hive_table_iam_policy. - GoogleBiglakeIcebergCatalog
-
Factory wrapper for
google_biglake_iceberg_catalog. - GoogleBiglakeIcebergCatalogIamBinding
-
Factory wrapper for
google_biglake_iceberg_catalog_iam_binding. - GoogleBiglakeIcebergCatalogIamMember
-
Factory wrapper for
google_biglake_iceberg_catalog_iam_member. - GoogleBiglakeIcebergCatalogIamPolicy
-
Factory wrapper for
google_biglake_iceberg_catalog_iam_policy. - GoogleBiglakeIcebergNamespace
-
Factory wrapper for
google_biglake_iceberg_namespace. - GoogleBiglakeIcebergNamespaceIamBinding
-
Factory wrapper for
google_biglake_iceberg_namespace_iam_binding. - GoogleBiglakeIcebergNamespaceIamMember
-
Factory wrapper for
google_biglake_iceberg_namespace_iam_member. - GoogleBiglakeIcebergNamespaceIamPolicy
-
Factory wrapper for
google_biglake_iceberg_namespace_iam_policy. - GoogleBiglakeIcebergTable
-
Factory wrapper for
google_biglake_iceberg_table. - GoogleBiglakeIcebergTableIamBinding
-
Factory wrapper for
google_biglake_iceberg_table_iam_binding. - GoogleBiglakeIcebergTableIamMember
-
Factory wrapper for
google_biglake_iceberg_table_iam_member. - GoogleBiglakeIcebergTableIamPolicy
-
Factory wrapper for
google_biglake_iceberg_table_iam_policy. - GoogleBiglakeTable
-
Factory wrapper for
google_biglake_table. - IgnoreAllChanges
- IgnoreChanges.all.
- IgnoreAttributes
- IgnoreChanges.of.
- IgnoreChanges
-
What
ignore_changescovers: every attribute, or the listed ones. - InvalidDartDefineOutput
-
An output of
Stack.addDartDefineOutputthat cannot carry what it names: an output that is not registered, is sensitive or has no environment value, two outputs read from one variable, or no output at all. - InvalidLifecycle
-
A
lifecycleblock Terraform rejects: a data source (or one of its attributes) inreplaceTriggeredBy,allinside IgnoreChanges.of, or a condition with an empty error message. - InvalidMoveTarget
-
A
movedblock whosetonames no resource of the Stack. - InvalidTimeout
-
A negative
timeoutsduration. - LifecycleCondition
-
A
preconditionorpostconditionblock: Terraform fails the plan (LifecycleCondition.pre) or the apply (LifecycleCondition.post) with errorMessage when condition is false. - LifecycleOptions
-
lifecycle { ... }block on a resource. - LocalBackend
-
terraform { backend "local" { ... } }configuration. - MissingProvider
-
A block needs a provider configuration the Stack does not register:
the provider its type implies (
googleforgoogle_pubsub_topic), the one itsprovidermeta-argument names, or one a module call passes on. - ModuleCall
-
A
module "<localName>" { ... }call as a Dart value. - NoProviders
- The Stack registers no provider, but declares resources or data sources.
- ProviderConflict
- Two provider registrations Terraform rejects together: two defaults of one name, a repeated alias, an alias that is not an identifier, or configurations of one name with different source / version constraints.
-
RefConstant<
T> - The AppConstant.ref choice.
- ReplaceTrigger
-
What
lifecycle.replaceTriggeredBylists: a resource of the Stack or an attribute getter of one.Resourceand TfRef implement it; synth reports a data source or a data-source attribute as anInvalidLifecycle. - Resource
- Base of every user-instantiable Terraform resource.
- ResourceRef
-
Public for sealed pattern matching, but constructor is private — only
TfRef.resource()may construct instances. - S3Backend
-
terraform { backend "s3" { ... } }configuration. -
Sensitive<
T> -
What an argument Terraform marks sensitive takes: a variable, an
expression or an attribute getter — a value Terraform resolves, never a
Dart literal that would be written into
main.tf.json. - SensitiveLiteral
-
A sensitive field is set to a literal, which would write the secret in
plain text into
main.tf.json. - Stack
- User-extended IaC composition root.
- StackBackend
-
Lightweight backend hook. Core ships
GcsBackend,S3Backend, andLocalBackend; anything else implements this interface in the caller. TheStackonly stores the value and exposes a discriminator for synth'sterraform { backend ... }emitter. - StackProvider
-
Coordination interface between
Stack(in this package) and concrete providers (e.g.GoogleProviderinterradart_google). Concrete providers implement every getter using their baked-in constants from Stage 2 codegen. - SynthIssue
- One reason a Stack cannot be synthesized.
- SynthResult
-
Bundle returned by
StackSynth.synth. - TfAddressed
-
Anything that exposes a Terraform address, e.g.
google_pubsub_topic.orders. -
TfArg<
T> - A Terraform argument: a Dart-side literal, a reference to another block's attribute (TfRef), a variable or a raw expression.
-
TfArgExpression<
T> - A raw Terraform expression — the tf.json template string, verbatim.
-
TfArgLiteral<
T> -
TfArgVariable<
T> - TfCollectionType
-
list(...),set(...)ormap(...). - TfMoved
-
One
moved { from = ... to = ... }block: the state object at from now belongs to the resource at to, so a rename does not become a destroy-and-create. - TfObjectType
-
object({ ... }). - TfOptionalType
-
optional(<type>[, <default>]). -
TfOutput<
T> -
An
output "<name>" { value = ... }block, registered withStack.addOutput. - TfPrimitiveType
-
string,number,boolorany. -
TfRef<
T> - A Terraform-side reference: an attribute of a resource (AttributeRef) or a data source (DataRef), or a whole resource (ResourceRef).
- TfTimeouts
-
timeouts { ... }on a resource or data source: how long Terraform waits for each operation before giving up. - TfTupleType
-
tuple([...]). - TfType
-
A Terraform type constraint:
string,list(number),object({ name = string }). - TfVariable
-
One
variable "<name>" { ... }declaration. - UndeclaredVariable
-
A
TfArg.variableorvar.<name>in an expression names a variable the Stack does not declare. - UnregisteredReference
-
A block references another block that was never registered on the
Stack: built, but not passed to
add(...)/addModule(...). - UnresolvableConstant
-
An
AppConstant.refwhose value is not known at synth: the attribute is not set to a literal, is sensitive, does not match the constant's type, or belongs to a block that is not registered. -
ValueConstant<
T> - The AppConstant.value choice.
Enums
- ResourceKind
-
Whether a Stack entry is a
resourceblock or adatablock in Terraform JSON.
Extension Types
- BiglakeHiveTableSerdeType
-
serde_type— derived from the provider schema description. - BiglakeIcebergCatalogCredentialMode
-
Terraform
credential_modefor GoogleBiglakeIcebergCatalog. - BiglakeIcebergCatalogType
-
Terraform
catalog_typefor GoogleBiglakeIcebergCatalog. - OutputEnvironment
-
The environment
Stack.outputEnvironmentreturns: each variable and its value, in registration order. - RefTo
-
A reference to a resource of type
R, for an argument that names another resource (network,vpc_id,role_arn, ...).
Extensions
-
RefToList
on TfArg<
List< RefTo< >R> > -
A list-valued reference argument (
security_group_ids,subnet_ids): a literal list of RefTos, or one value that is the whole list (TfArg.variable('subnet_ids'),TfArg.expression(...)). - TerraformDurationExt on Duration
- Converts a Dart Duration into a Terraform duration string ("604800s").
Constants
- terradartManifestVariable → const String
-
The environment variable the
terradartcommand sets to the file runStack and runEnvironments describe what they wrote in.
Functions
-
runEnvironments<
E extends Enum> (List< String> args, List<E> environments, Stack build(E env), {String dir(E env)?, String? workspace(E env)?, List<String> backendConfig(E env)?, E? defaultEnv}) → Future<void> -
The entry point of a project with one Stack per environment. The
environments are the members of an enum of the project's own — any
names, each carrying its values — so the Stack takes a typed
envand derives everything per environment from it, its backend included: -
runStack(
List< String> args, Stack build(), {String out = 'tf-out'}) → Future<void> -
The entry point of a project with one Stack: writes it to
out.
Exceptions / Errors
- DuplicateModuleError
-
A
ModuleCallregistered twice under one name. - DuplicateResourceError
-
Thrown by
Stack.addwhen an entry with the same(kind, terraformType, localName)triple is registered twice. - SynthException
-
Thrown by
Stack.synth()andStack.writeTo()when the Stack has one or more SynthIssues. Nothing is written.