Skip to content

Latest commit

 

History

History
134 lines (83 loc) · 4.12 KB

sql_database.md

File metadata and controls

134 lines (83 loc) · 4.12 KB
Raw
permalink
/data/sql_database/

data.sql_database

sql_database represents the google_sql_database Terraform data source.

This package contains functions and utilities for setting up the data source using Jsonnet code.

Index

Fields

fn new

new()

google.data.sql_database.new injects a new data_google_sql_database Terraform data source block into the root module document.

Additionally, this inserts a private function into the _ref attribute that generates references to attributes of the resource. For example, if you added a new instance to the root using:

# arguments omitted for brevity
google.data.sql_database.new('some_id')

You can get the reference to the id field of the created google.data.sql_database using the reference:

$._ref.data_google_sql_database.some_id.get('id')

This is the same as directly entering "${ data_google_sql_database.some_id.id }" as the value.

NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use super, self, or $ to refer to the root object. Instead, make an explicit outer object using local.

Args:

  • dataSrcLabel (string): The name label of the block.
  • instance (string): The name of the Cloud SQL instance. This does not include the project ID.
  • name (string): The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.
  • project (string): Set the project field on the resulting data source block. When null, the project field will be omitted from the resulting object.

Returns:

  • A mixin object that injects the new data source into the root Terraform configuration.

fn newAttrs

newAttrs()

google.data.sql_database.newAttrs constructs a new object with attributes and blocks configured for the sql_database Terraform data source.

Unlike google.data.sql_database.new, this function will not inject the data source block into the root Terraform document. Instead, this must be passed in as the attrs argument for the tf.withData function to build a complete block.

This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to injecting into a complete block.

Args:

  • instance (string): The name of the Cloud SQL instance. This does not include the project ID.
  • name (string): The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.
  • project (string): Set the project field on the resulting object. When null, the project field will be omitted from the resulting object.

Returns:

  • An attribute object that can be used with tf.withData to construct a new sql_database data source into the root Terraform configuration.

fn withInstance

withInstance()

google.string.withInstance constructs a mixin object that can be merged into the string Terraform data source block to set or update the instance field.

Args:

  • dataSrcLabel (string): The name label of the block to update.
  • value (string): The value to set for the instance field.

fn withName

withName()

google.string.withName constructs a mixin object that can be merged into the string Terraform data source block to set or update the name field.

Args:

  • dataSrcLabel (string): The name label of the block to update.
  • value (string): The value to set for the name field.

fn withProject

withProject()

google.string.withProject constructs a mixin object that can be merged into the string Terraform data source block to set or update the project field.

Args:

  • dataSrcLabel (string): The name label of the block to update.
  • value (string): The value to set for the project field.