Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. DataRobot
  3. API Docs
  4. Datasource
DataRobot v0.5.1 published on Friday, Nov 29, 2024 by DataRobot, Inc.
datarobot-community/pulumi-datarobot

datarobot.Datasource

Explore with Pulumi AI

datarobot logo
DataRobot v0.5.1 published on Friday, Nov 29, 2024 by DataRobot, Inc.
datarobot-community/pulumi-datarobot

    Data source

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.datarobot.Datasource;
import com.pulumi.datarobot.DatasourceArgs;
import com.pulumi.datarobot.inputs.DatasourceParamsArgs;
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) {
        var exampleDatabaseTable = new Datasource("exampleDatabaseTable", DatasourceArgs.builder()
            .canonicalName("Example Database Table Data Source")
            .dataSourceType("dr-database-v1")
            .params(DatasourceParamsArgs.builder()
                .data_store_id(datarobot_datastore.example_database().id())
                .catalog("my-catalog")
                .schema("my-schema")
                .table("my-table")
                .build())
            .build());

        var exampleDatabaseQuery = new Datasource("exampleDatabaseQuery", DatasourceArgs.builder()
            .canonicalName("Example Database Query Data Source")
            .dataSourceType("dr-database-v1")
            .params(DatasourceParamsArgs.builder()
                .data_store_id(datarobot_datastore.example_database().id())
                .query("SELECT * FROM my-table")
                .build())
            .build());

        var exampleConnector = new Datasource("exampleConnector", DatasourceArgs.builder()
            .canonicalName("Example Connector Data Source")
            .dataSourceType("dr-connector-v1")
            .params(DatasourceParamsArgs.builder()
                .data_store_id(datarobot_datastore.example_connector().id())
                .path("/my-folder/my-file.csv")
                .build())
            .build());

        ctx.export("exampleId", exampleDatabaseTable.id());
    }
}

    resources:
  exampleDatabaseTable:
    type: datarobot:Datasource
    properties:
      canonicalName: Example Database Table Data Source
      dataSourceType: dr-database-v1
      params:
        data_store_id: ${datarobot_datastore.example_database.id}
        catalog: my-catalog
        schema: my-schema
        table: my-table
  exampleDatabaseQuery:
    type: datarobot:Datasource
    properties:
      canonicalName: Example Database Query Data Source
      dataSourceType: dr-database-v1
      params:
        data_store_id: ${datarobot_datastore.example_database.id}
        query: SELECT * FROM my-table
  exampleConnector:
    type: datarobot:Datasource
    properties:
      canonicalName: Example Connector Data Source
      dataSourceType: dr-connector-v1
      params:
        data_store_id: ${datarobot_datastore.example_connector.id}
        path: /my-folder/my-file.csv
outputs:
  exampleId: ${exampleDatabaseTable.id}

    Create Datasource Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Datasource(name: string, args: DatasourceArgs, opts?: CustomResourceOptions);
    @overload
def Datasource(resource_name: str,
               args: DatasourceArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Datasource(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               canonical_name: Optional[str] = None,
               data_source_type: Optional[str] = None,
               params: Optional[DatasourceParamsArgs] = None)
    func NewDatasource(ctx *Context, name string, args DatasourceArgs, opts ...ResourceOption) (*Datasource, error)
    public Datasource(string name, DatasourceArgs args, CustomResourceOptions? opts = null)
    public Datasource(String name, DatasourceArgs args)
public Datasource(String name, DatasourceArgs args, CustomResourceOptions options)

    type: datarobot:Datasource
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DatasourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DatasourceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DatasourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatasourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatasourceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var datasourceResource = new Datarobot.Datasource("datasourceResource", new()
{
    CanonicalName = "string",
    DataSourceType = "string",
    Params = new Datarobot.Inputs.DatasourceParamsArgs
    {
        DataStoreId = "string",
        Catalog = "string",
        FetchSize = 0,
        PartitionColumn = "string",
        Path = "string",
        Query = "string",
        Schema = "string",
        Table = "string",
    },
});

    example, err := datarobot.NewDatasource(ctx, "datasourceResource", &datarobot.DatasourceArgs{
	CanonicalName:  pulumi.String("string"),
	DataSourceType: pulumi.String("string"),
	Params: &datarobot.DatasourceParamsArgs{
		DataStoreId:     pulumi.String("string"),
		Catalog:         pulumi.String("string"),
		FetchSize:       pulumi.Int(0),
		PartitionColumn: pulumi.String("string"),
		Path:            pulumi.String("string"),
		Query:           pulumi.String("string"),
		Schema:          pulumi.String("string"),
		Table:           pulumi.String("string"),
	},
})

    var datasourceResource = new Datasource("datasourceResource", DatasourceArgs.builder()
    .canonicalName("string")
    .dataSourceType("string")
    .params(DatasourceParamsArgs.builder()
        .dataStoreId("string")
        .catalog("string")
        .fetchSize(0)
        .partitionColumn("string")
        .path("string")
        .query("string")
        .schema("string")
        .table("string")
        .build())
    .build());

    datasource_resource = datarobot.Datasource("datasourceResource",
    canonical_name="string",
    data_source_type="string",
    params={
        "data_store_id": "string",
        "catalog": "string",
        "fetch_size": 0,
        "partition_column": "string",
        "path": "string",
        "query": "string",
        "schema": "string",
        "table": "string",
    })

    const datasourceResource = new datarobot.Datasource("datasourceResource", {
    canonicalName: "string",
    dataSourceType: "string",
    params: {
        dataStoreId: "string",
        catalog: "string",
        fetchSize: 0,
        partitionColumn: "string",
        path: "string",
        query: "string",
        schema: "string",
        table: "string",
    },
});

    type: datarobot:Datasource
properties:
    canonicalName: string
    dataSourceType: string
    params:
        catalog: string
        dataStoreId: string
        fetchSize: 0
        partitionColumn: string
        path: string
        query: string
        schema: string
        table: string

    Datasource Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Datasource resource accepts the following input properties:

    CanonicalName string
    The user-friendly name of the data source.
    DataSourceType string
    The type of data source.
    Params DataRobotDatasourceParams
    The data source parameters.
    CanonicalName string
    The user-friendly name of the data source.
    DataSourceType string
    The type of data source.
    Params DatasourceParamsArgs
    The data source parameters.
    canonicalName String
    The user-friendly name of the data source.
    dataSourceType String
    The type of data source.
    params DatasourceParams
    The data source parameters.
    canonicalName string
    The user-friendly name of the data source.
    dataSourceType string
    The type of data source.
    params DatasourceParams
    The data source parameters.
    canonical_name str
    The user-friendly name of the data source.
    data_source_type str
    The type of data source.
    params DatasourceParamsArgs
    The data source parameters.
    canonicalName String
    The user-friendly name of the data source.
    dataSourceType String
    The type of data source.
    params Property Map
    The data source parameters.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Datasource resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Datasource Resource

    Get an existing Datasource resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DatasourceState, opts?: CustomResourceOptions): Datasource
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        canonical_name: Optional[str] = None,
        data_source_type: Optional[str] = None,
        params: Optional[DatasourceParamsArgs] = None) -> Datasource
    func GetDatasource(ctx *Context, name string, id IDInput, state *DatasourceState, opts ...ResourceOption) (*Datasource, error)
    public static Datasource Get(string name, Input<string> id, DatasourceState? state, CustomResourceOptions? opts = null)
    public static Datasource get(String name, Output<String> id, DatasourceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CanonicalName string
    The user-friendly name of the data source.
    DataSourceType string
    The type of data source.
    Params DataRobotDatasourceParams
    The data source parameters.
    CanonicalName string
    The user-friendly name of the data source.
    DataSourceType string
    The type of data source.
    Params DatasourceParamsArgs
    The data source parameters.
    canonicalName String
    The user-friendly name of the data source.
    dataSourceType String
    The type of data source.
    params DatasourceParams
    The data source parameters.
    canonicalName string
    The user-friendly name of the data source.
    dataSourceType string
    The type of data source.
    params DatasourceParams
    The data source parameters.
    canonical_name str
    The user-friendly name of the data source.
    data_source_type str
    The type of data source.
    params DatasourceParamsArgs
    The data source parameters.
    canonicalName String
    The user-friendly name of the data source.
    dataSourceType String
    The type of data source.
    params Property Map
    The data source parameters.

    Supporting Types

    DatasourceParams, DatasourceParamsArgs

    DataStoreId string
    The id of the DataStore.
    Catalog string
    The Catalog name in the database if supported.
    FetchSize int
    A user specified fetch size in the range [1, 20000]. By default a fetchSize will be assigned to balance throughput and memory usage.
    PartitionColumn string
    The name of the partition column.
    Path string
    The user-specified path for BLOB storage.
    Query string
    The user specified SQL query.
    Schema string
    The name of the schema associated with the table.
    Table string
    The name of specified database table.
    DataStoreId string
    The id of the DataStore.
    Catalog string
    The Catalog name in the database if supported.
    FetchSize int
    A user specified fetch size in the range [1, 20000]. By default a fetchSize will be assigned to balance throughput and memory usage.
    PartitionColumn string
    The name of the partition column.
    Path string
    The user-specified path for BLOB storage.
    Query string
    The user specified SQL query.
    Schema string
    The name of the schema associated with the table.
    Table string
    The name of specified database table.
    dataStoreId String
    The id of the DataStore.
    catalog String
    The Catalog name in the database if supported.
    fetchSize Integer
    A user specified fetch size in the range [1, 20000]. By default a fetchSize will be assigned to balance throughput and memory usage.
    partitionColumn String
    The name of the partition column.
    path String
    The user-specified path for BLOB storage.
    query String
    The user specified SQL query.
    schema String
    The name of the schema associated with the table.
    table String
    The name of specified database table.
    dataStoreId string
    The id of the DataStore.
    catalog string
    The Catalog name in the database if supported.
    fetchSize number
    A user specified fetch size in the range [1, 20000]. By default a fetchSize will be assigned to balance throughput and memory usage.
    partitionColumn string
    The name of the partition column.
    path string
    The user-specified path for BLOB storage.
    query string
    The user specified SQL query.
    schema string
    The name of the schema associated with the table.
    table string
    The name of specified database table.
    data_store_id str
    The id of the DataStore.
    catalog str
    The Catalog name in the database if supported.
    fetch_size int
    A user specified fetch size in the range [1, 20000]. By default a fetchSize will be assigned to balance throughput and memory usage.
    partition_column str
    The name of the partition column.
    path str
    The user-specified path for BLOB storage.
    query str
    The user specified SQL query.
    schema str
    The name of the schema associated with the table.
    table str
    The name of specified database table.
    dataStoreId String
    The id of the DataStore.
    catalog String
    The Catalog name in the database if supported.
    fetchSize Number
    A user specified fetch size in the range [1, 20000]. By default a fetchSize will be assigned to balance throughput and memory usage.
    partitionColumn String
    The name of the partition column.
    path String
    The user-specified path for BLOB storage.
    query String
    The user specified SQL query.
    schema String
    The name of the schema associated with the table.
    table String
    The name of specified database table.

    Package Details

    Repository
    datarobot datarobot-community/pulumi-datarobot
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the datarobot Terraform Provider.
    datarobot logo
    DataRobot v0.5.1 published on Friday, Nov 29, 2024 by DataRobot, Inc.
    datarobot-community/pulumi-datarobot