1. Packages
  2. Snowflake Provider
  3. API Docs
  4. getExternalTables
Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi

snowflake.getExternalTables

Explore with Pulumi AI

Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi

!> Caution: Preview Feature This feature is considered a preview feature in the provider, regardless of the state of the resource in Snowflake. We do not guarantee its stability. It will be reworked and marked as a stable feature in future releases. Breaking changes are expected, even without bumping the major version. To use this feature, add the relevant feature name to preview_features_enabled field in the provider configuration. Please always refer to the Getting Help section in our Github repo to best determine how to get help for your questions.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as snowflake from "@pulumi/snowflake";

const current = snowflake.getExternalTables({
    database: "MYDB",
    schema: "MYSCHEMA",
});
Copy
import pulumi
import pulumi_snowflake as snowflake

current = snowflake.get_external_tables(database="MYDB",
    schema="MYSCHEMA")
Copy
package main

import (
	"github.com/pulumi/pulumi-snowflake/sdk/go/snowflake"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := snowflake.GetExternalTables(ctx, &snowflake.GetExternalTablesArgs{
			Database: "MYDB",
			Schema:   "MYSCHEMA",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Snowflake = Pulumi.Snowflake;

return await Deployment.RunAsync(() => 
{
    var current = Snowflake.GetExternalTables.Invoke(new()
    {
        Database = "MYDB",
        Schema = "MYSCHEMA",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.SnowflakeFunctions;
import com.pulumi.snowflake.inputs.GetExternalTablesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var current = SnowflakeFunctions.getExternalTables(GetExternalTablesArgs.builder()
            .database("MYDB")
            .schema("MYSCHEMA")
            .build());

    }
}
Copy
variables:
  current:
    fn::invoke:
      function: snowflake:getExternalTables
      arguments:
        database: MYDB
        schema: MYSCHEMA
Copy

Using getExternalTables

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getExternalTables(args: GetExternalTablesArgs, opts?: InvokeOptions): Promise<GetExternalTablesResult>
function getExternalTablesOutput(args: GetExternalTablesOutputArgs, opts?: InvokeOptions): Output<GetExternalTablesResult>
Copy
def get_external_tables(database: Optional[str] = None,
                        schema: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetExternalTablesResult
def get_external_tables_output(database: Optional[pulumi.Input[str]] = None,
                        schema: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetExternalTablesResult]
Copy
func GetExternalTables(ctx *Context, args *GetExternalTablesArgs, opts ...InvokeOption) (*GetExternalTablesResult, error)
func GetExternalTablesOutput(ctx *Context, args *GetExternalTablesOutputArgs, opts ...InvokeOption) GetExternalTablesResultOutput
Copy

> Note: This function is named GetExternalTables in the Go SDK.

public static class GetExternalTables 
{
    public static Task<GetExternalTablesResult> InvokeAsync(GetExternalTablesArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalTablesResult> Invoke(GetExternalTablesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetExternalTablesResult> getExternalTables(GetExternalTablesArgs args, InvokeOptions options)
public static Output<GetExternalTablesResult> getExternalTables(GetExternalTablesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: snowflake:index/getExternalTables:getExternalTables
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Database This property is required. string
The database from which to return the schemas from.
Schema This property is required. string
The schema from which to return the external tables from.
Database This property is required. string
The database from which to return the schemas from.
Schema This property is required. string
The schema from which to return the external tables from.
database This property is required. String
The database from which to return the schemas from.
schema This property is required. String
The schema from which to return the external tables from.
database This property is required. string
The database from which to return the schemas from.
schema This property is required. string
The schema from which to return the external tables from.
database This property is required. str
The database from which to return the schemas from.
schema This property is required. str
The schema from which to return the external tables from.
database This property is required. String
The database from which to return the schemas from.
schema This property is required. String
The schema from which to return the external tables from.

getExternalTables Result

The following output properties are available:

Database string
The database from which to return the schemas from.
ExternalTables List<GetExternalTablesExternalTable>
The external tables in the schema
Id string
The provider-assigned unique ID for this managed resource.
Schema string
The schema from which to return the external tables from.
Database string
The database from which to return the schemas from.
ExternalTables []GetExternalTablesExternalTable
The external tables in the schema
Id string
The provider-assigned unique ID for this managed resource.
Schema string
The schema from which to return the external tables from.
database String
The database from which to return the schemas from.
externalTables List<GetExternalTablesExternalTable>
The external tables in the schema
id String
The provider-assigned unique ID for this managed resource.
schema String
The schema from which to return the external tables from.
database string
The database from which to return the schemas from.
externalTables GetExternalTablesExternalTable[]
The external tables in the schema
id string
The provider-assigned unique ID for this managed resource.
schema string
The schema from which to return the external tables from.
database str
The database from which to return the schemas from.
external_tables Sequence[GetExternalTablesExternalTable]
The external tables in the schema
id str
The provider-assigned unique ID for this managed resource.
schema str
The schema from which to return the external tables from.
database String
The database from which to return the schemas from.
externalTables List<Property Map>
The external tables in the schema
id String
The provider-assigned unique ID for this managed resource.
schema String
The schema from which to return the external tables from.

Supporting Types

GetExternalTablesExternalTable

Comment This property is required. string
Database This property is required. string
Name This property is required. string
Schema This property is required. string
Comment This property is required. string
Database This property is required. string
Name This property is required. string
Schema This property is required. string
comment This property is required. String
database This property is required. String
name This property is required. String
schema This property is required. String
comment This property is required. string
database This property is required. string
name This property is required. string
schema This property is required. string
comment This property is required. str
database This property is required. str
name This property is required. str
schema This property is required. str
comment This property is required. String
database This property is required. String
name This property is required. String
schema This property is required. String

Package Details

Repository
Snowflake pulumi/pulumi-snowflake
License
Apache-2.0
Notes
This Pulumi package is based on the snowflake Terraform Provider.
Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi