Skip to content

Updates a metadata table in the Data Catalog

Description

Updates a metadata table in the Data Catalog.

Usage

glue_update_table(CatalogId, DatabaseName, Name, TableInput,
  SkipArchive, TransactionId, VersionId, ViewUpdateAction, Force,
  UpdateOpenTableFormatInput)

Arguments

  • CatalogId

    The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account ID is used by default.

  • DatabaseName

    [required] The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.

  • Name

    The unique identifier for the table within the specified database that will be created in the Glue Data Catalog.

  • TableInput

    An updated TableInput object to define the metadata table in the catalog.

  • SkipArchive

    By default, update_table always creates an archived version of the table before updating it. However, if skipArchive is set to true, update_table does not create the archived version.

  • TransactionId

    The transaction ID at which to update the table contents.

  • VersionId

    The version ID at which to update the table contents.

  • ViewUpdateAction

    The operation to be performed when updating the view.

  • Force

    A flag that can be set to true to ignore matching storage descriptor and subobject matching requirements.

  • UpdateOpenTableFormatInput

    Input parameters for updating open table format tables in GlueData Catalog, serving as a wrapper for format-specific update operations such as Apache Iceberg.

Value

An empty list.

Request syntax

svc$update_table(
  CatalogId = "string",
  DatabaseName = "string",
  Name = "string",
  TableInput = list(
    Name = "string",
    Description = "string",
    Owner = "string",
    LastAccessTime = as.POSIXct(
      "2015-01-01"
    ),
    LastAnalyzedTime = as.POSIXct(
      "2015-01-01"
    ),
    Retention = 123,
    StorageDescriptor = list(
      Columns = list(
        list(
          Name = "string",
          Type = "string",
          Comment = "string",
          Parameters = list(
            "string"
          )
        )
      ),
      Location = "string",
      AdditionalLocations = list(
        "string"
      ),
      InputFormat = "string",
      OutputFormat = "string",
      Compressed = TRUE|FALSE,
      NumberOfBuckets = 123,
      SerdeInfo = list(
        Name = "string",
        SerializationLibrary = "string",
        Parameters = list(
          "string"
        )
      ),
      BucketColumns = list(
        "string"
      ),
      SortColumns = list(
        list(
          Column = "string",
          SortOrder = 123
        )
      ),
      Parameters = list(
        "string"
      ),
      SkewedInfo = list(
        SkewedColumnNames = list(
          "string"
        ),
        SkewedColumnValues = list(
          "string"
        ),
        SkewedColumnValueLocationMaps = list(
          "string"
        )
      ),
      StoredAsSubDirectories = TRUE|FALSE,
      SchemaReference = list(
        SchemaId = list(
          SchemaArn = "string",
          SchemaName = "string",
          RegistryName = "string"
        ),
        SchemaVersionId = "string",
        SchemaVersionNumber = 123
      )
    ),
    PartitionKeys = list(
      list(
        Name = "string",
        Type = "string",
        Comment = "string",
        Parameters = list(
          "string"
        )
      )
    ),
    ViewOriginalText = "string",
    ViewExpandedText = "string",
    TableType = "string",
    Parameters = list(
      "string"
    ),
    TargetTable = list(
      CatalogId = "string",
      DatabaseName = "string",
      Name = "string",
      Region = "string"
    ),
    FederatedTable = list(
      Identifier = "string",
      DatabaseIdentifier = "string",
      ConnectionName = "string",
      ConnectionType = "string"
    ),
    ViewDefinition = list(
      IsProtected = TRUE|FALSE,
      IsManaged = TRUE|FALSE,
      Definer = "string",
      Representations = list(
        list(
          Dialect = "REDSHIFT"|"ATHENA"|"SPARK",
          DialectVersion = "string",
          ViewOriginalText = "string",
          ValidationConnection = "string",
          ViewExpandedText = "string"
        )
      ),
      ViewVersionId = 123,
      ViewVersionToken = "string",
      RefreshSeconds = 123,
      LastRefreshType = "FULL"|"INCREMENTAL",
      SubObjects = list(
        "string"
      ),
      SubObjectVersionIds = list(
        123
      ),
      SubObjectsStatistics = list(
        list(
          SourceType = "HIVE_PARQUET"|"HIVE_ORC"|"HIVE_CSV"|"HIVE_JSON"|"PLAIN_PARQUET"|"ICEBERG",
          GlueVersionId = "string",
          PartitionCount = 123,
          FileCount = 123,
          TotalFileBytes = 123
        )
      ),
      SparkPipelineInfo = list(
        "string"
      )
    )
  ),
  SkipArchive = TRUE|FALSE,
  TransactionId = "string",
  VersionId = "string",
  ViewUpdateAction = "ADD"|"REPLACE"|"ADD_OR_REPLACE"|"DROP",
  Force = TRUE|FALSE,
  UpdateOpenTableFormatInput = list(
    UpdateIcebergInput = list(
      UpdateIcebergTableInput = list(
        Updates = list(
          list(
            Schema = list(
              SchemaId = 123,
              IdentifierFieldIds = list(
                123
              ),
              Type = "struct",
              Fields = list(
                list(
                  Id = 123,
                  Name = "string",
                  Type = list(),
                  Required = TRUE|FALSE,
                  Doc = "string",
                  InitialDefault = list(),
                  WriteDefault = list()
                )
              )
            ),
            PartitionSpec = list(
              Fields = list(
                list(
                  SourceId = 123,
                  Transform = "string",
                  Name = "string",
                  FieldId = 123
                )
              ),
              SpecId = 123
            ),
            SortOrder = list(
              OrderId = 123,
              Fields = list(
                list(
                  SourceId = 123,
                  Transform = "string",
                  Direction = "asc"|"desc",
                  NullOrder = "nulls-first"|"nulls-last"
                )
              )
            ),
            Location = "string",
            Properties = list(
              "string"
            ),
            Action = "add-schema"|"set-current-schema"|"add-spec"|"set-default-spec"|"add-sort-order"|"set-default-sort-order"|"set-location"|"set-properties"|"remove-properties"|"add-encryption-key"|"remove-encryption-key",
            EncryptionKey = list(
              KeyId = "string",
              EncryptedKeyMetadata = "string",
              EncryptedById = "string",
              Properties = list(
                "string"
              )
            ),
            KeyId = "string"
          )
        )
      )
    )
  )
)