[ aws . glue ]

update-database

Description

Updates an existing database definition in a Data Catalog.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-database
[--catalog-id <value>]
--name <value>
--database-input <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--catalog-id (string)

The ID of the Data Catalog in which the metadata database resides. If none is provided, the Amazon Web Services account ID is used by default.

--name (string)

The name of the database to update in the catalog. For Hive compatibility, this is folded to lowercase.

--database-input (structure)

A DatabaseInput object specifying the new definition of the metadata database in the catalog.

Name -> (string)

The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.

Description -> (string)

A description of the database.

LocationUri -> (string)

The location of the database (for example, an HDFS path).

Parameters -> (map)

These key-value pairs define parameters and properties of the database.

These key-value pairs define parameters and properties of the database.

key -> (string)

value -> (string)

CreateTableDefaultPermissions -> (list)

Creates a set of default permissions on the table for principals.

(structure)

Permissions granted to a principal.

Principal -> (structure)

The principal who is granted permissions.

DataLakePrincipalIdentifier -> (string)

An identifier for the Lake Formation principal.

Permissions -> (list)

The permissions that are granted to the principal.

(string)

TargetDatabase -> (structure)

A DatabaseIdentifier structure that describes a target database for resource linking.

CatalogId -> (string)

The ID of the Data Catalog in which the database resides.

DatabaseName -> (string)

The name of the catalog database.

JSON Syntax:

{
  "Name": "string",
  "Description": "string",
  "LocationUri": "string",
  "Parameters": {"string": "string"
    ...},
  "CreateTableDefaultPermissions": [
    {
      "Principal": {
        "DataLakePrincipalIdentifier": "string"
      },
      "Permissions": ["ALL"|"SELECT"|"ALTER"|"DROP"|"DELETE"|"INSERT"|"CREATE_DATABASE"|"CREATE_TABLE"|"DATA_LOCATION_ACCESS", ...]
    }
    ...
  ],
  "TargetDatabase": {
    "CatalogId": "string",
    "DatabaseName": "string"
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

None