Class TableBase

(experimental) A Glue table.

Inheritance

object

Resource

TableBase

ExternalTable

S3Table

Implements

ITable

IResource

IConstruct

IDependable

IEnvironmentAware

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.Glue.Alpha

Assembly: Amazon.CDK.AWS.Glue.Alpha.dll

Syntax (csharp)

public abstract class TableBase : Resource, ITable, IResource, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public MustInherit Class TableBase Inherits Resource Implements ITable, IResource, IConstruct, IDependable, IEnvironmentAware

Remarks

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Glue.Alpha;

             var tableBase = TableBase.FromTableArn(this, "MyTableBase", "tableArn");

Synopsis

Constructors

TableBase(Construct, string, ITableBaseProps)

(experimental) A Glue table.

Properties

Columns	(experimental) This table's columns.
Compressed	(experimental) Indicates whether the table's data is compressed or not.
DataFormat	(experimental) Format of this table's data files.
Database	(experimental) Database this table belongs to.
Parameters	(experimental) The tables' properties associated with the table.
PartitionIndexes	(experimental) A Glue table.
PartitionKeys	(experimental) This table's partition keys if the table is partitioned.
StorageParameters	(experimental) The tables' storage descriptor properties.
TableArn	(experimental) A Glue table.
TableName	(experimental) A Glue table.
TableResource	(experimental) A Glue table.

Methods

AddPartitionIndex(IPartitionIndex)	(experimental) Add a partition index to the table.
FromTableArn(Construct, string, string)	(experimental) A Glue table.
FromTableAttributes(Construct, string, ITableAttributes)	(experimental) Creates a Table construct that represents an external table.
Grant(IGrantable, string[])	(experimental) Grant the given identity custom permissions.
GrantRead(IGrantable)	(experimental) A Glue table.
GrantReadWrite(IGrantable)	(experimental) A Glue table.
GrantToUnderlyingResources(IGrantable, string[])	(experimental) Grant the given identity custom permissions to ALL underlying resources of the table.
GrantWrite(IGrantable)	(experimental) A Glue table.

Constructors

TableBase(Construct, string, ITableBaseProps)

(experimental) A Glue table.

protected TableBase(Construct scope, string id, ITableBaseProps props)

Parameters

scope Construct
id string
props ITableBaseProps

Remarks

Stability: Experimental

Properties

Columns

(experimental) This table's columns.

public virtual IColumn[] Columns { get; }

Property Value

IColumn[]

Remarks

Stability: Experimental

Compressed

(experimental) Indicates whether the table's data is compressed or not.

public virtual bool Compressed { get; }

Property Value

bool

Remarks

Stability: Experimental

DataFormat

(experimental) Format of this table's data files.

public virtual DataFormat DataFormat { get; }

Property Value

DataFormat

Remarks

Stability: Experimental

Database

(experimental) Database this table belongs to.

public virtual IDatabase Database { get; }

Property Value

IDatabase

Remarks

Stability: Experimental

Parameters

(experimental) The tables' properties associated with the table.

protected virtual IDictionary<string, string> Parameters { get; }

Property Value

IDictionary<string, string>

Remarks

Stability: Experimental

See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-parameters

PartitionIndexes

(experimental) A Glue table.

public abstract IPartitionIndex[]? PartitionIndexes { get; }

Property Value

IPartitionIndex[]

Remarks

Stability: Experimental

PartitionKeys

(experimental) This table's partition keys if the table is partitioned.

public virtual IColumn[]? PartitionKeys { get; }

Property Value

IColumn[]

Remarks

Stability: Experimental

StorageParameters

(experimental) The tables' storage descriptor properties.

public virtual StorageParameter[]? StorageParameters { get; }

Property Value

StorageParameter[]

Remarks

Stability: Experimental

TableArn

(experimental) A Glue table.

public abstract string TableArn { get; }

Property Value

string

Remarks

Stability: Experimental

TableName

(experimental) A Glue table.

public abstract string TableName { get; }

Property Value

string

Remarks

Stability: Experimental

TableResource

(experimental) A Glue table.

protected abstract CfnTable TableResource { get; }

Property Value

CfnTable

Remarks

Stability: Experimental

Methods

AddPartitionIndex(IPartitionIndex)

(experimental) Add a partition index to the table.

public virtual void AddPartitionIndex(IPartitionIndex index)

Parameters

index IPartitionIndex

Remarks

You can have a maximum of 3 partition indexes to a table. Partition index keys must be a subset of the table's partition keys.

Stability: Experimental

See: https://docs.aws.amazon.com/glue/latest/dg/partition-indexes.html

FromTableArn(Construct, string, string)

(experimental) A Glue table.

public static ITable FromTableArn(Construct scope, string id, string tableArn)

Parameters

scope Construct
id string
tableArn string

Returns

ITable

Remarks

Stability: Experimental

FromTableAttributes(Construct, string, ITableAttributes)

(experimental) Creates a Table construct that represents an external table.

public static ITable FromTableAttributes(Construct scope, string id, ITableAttributes attrs)

Parameters

scope Construct: The scope creating construct (usually this).
id string: The construct's id.
attrs ITableAttributes: Import attributes.

Returns

ITable

Remarks

Stability: Experimental

Grant(IGrantable, string[])

(experimental) Grant the given identity custom permissions.

public virtual Grant Grant(IGrantable grantee, string[] actions)

Parameters

grantee IGrantable
actions string[]

Returns

Grant

Remarks

Stability: Experimental

GrantRead(IGrantable)

(experimental) A Glue table.

public abstract Grant GrantRead(IGrantable grantee)

Parameters

grantee IGrantable

Returns

Grant

Remarks

Stability: Experimental

GrantReadWrite(IGrantable)

(experimental) A Glue table.

public abstract Grant GrantReadWrite(IGrantable grantee)

Parameters

grantee IGrantable

Returns

Grant

Remarks

Stability: Experimental

GrantToUnderlyingResources(IGrantable, string[])

(experimental) Grant the given identity custom permissions to ALL underlying resources of the table.

public virtual Grant GrantToUnderlyingResources(IGrantable grantee, string[] actions)

Parameters

grantee IGrantable
actions string[]

Returns

Grant

Remarks

Permissions will be granted to the catalog, the database, and the table.

Stability: Experimental

GrantWrite(IGrantable)

(experimental) A Glue table.

public abstract Grant GrantWrite(IGrantable grantee)

Parameters

grantee IGrantable

Returns

Grant

Remarks

Stability: Experimental

Implements

ITable

IResource

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware