cloudera.services.ssb_table module – Manage SSB project tables

Note

This module is part of the cloudera.services collection (version 1.0.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install git+https://github.com/cloudera-labs/cloudera.services.git.

To use it in a playbook, specify: cloudera.services.ssb_table.

New in cloudera.services 1.0.0

Synopsis

  • Create or delete Cloudera SSB project tables.

  • Tables define virtual tables that can be used in SQL queries.

  • Note that SSB tables cannot be updated in-place; you must delete and recreate them.

  • The module supports check_mode.

Parameters

Parameter

Comments

client_cert

path

The path to a client certificate for authenticating to the API endpoint.

client_key

path

The path to a client key for authenticating to the API endpoint.

debug

aliases: debug_endpoints

boolean

A flag to enable debug logging of the module’s execution.

Choices:

  • false ← (default)

  • true

force

boolean

A flag to force a refresh of the API request, ignoring any cached results.

Choices:

  • false ← (default)

  • true

force_basic_auth

boolean

A flag to force basic authentication for API requests.

Choices:

  • false ← (default)

  • true

http_agent

aliases: user_agent

string

The User-Agent string to send with API requests.

Default: "cloudera-services-module"

id

aliases: table_id

integer

The unique identifier of the table.

This parameter is mutually exclusive with table_name.

This field is read-only and cannot be modified after creation.

metadata

dictionary

Dictionary of metadata for the table.

The structure depends on the table type.

Required when creating a new table.

page_size

aliases: default_page_size

integer

The number of items to return per page in a paginated API response.

Default: 100

project_id

string / required

The unique identifier of the project.

Required for all operations.

state

string

The desired state of the table.

Use present to create a table.

Use absent to delete a table.

See update_enabled for handling updates to existing tables.

Choices:

  • "present" ← (default)

  • "absent"

table_name

string

The name of the table.

Required when creating a new table (state=present).

This parameter is mutually exclusive with id.

timeout

aliases: timeout_seconds

integer

The timeout in seconds for any API requests.

Default: 60

transform_code

string

Optional transformation code for the table.

transform_code_base64

boolean

Whether the transform_code is base64 encoded.

Choices:

  • false ← (default)

  • true

type

string

The type of the table, e.g. “kafka”.

Required when creating a new table.

update_enabled

boolean

Whether to enable updates by deleting and rebuilding the table.

When true, if a table exists but has different properties, it will be deleted and recreated.

When false, if a table exists, it will not be modified even if properties differ.

SSB tables cannot be updated in-place; this parameter emulates updates via delete-and-rebuild.

Choices:

  • false

  • true ← (default)

url

aliases: endpoint, endpoint_url

string / required

The base URL of the API endpoint, including the port if necessary.

url_password

string

The password for authenticating to the API endpoint.

url_username

string

The username for authenticating to the API endpoint.

use_gssapi

boolean

A flag to enable or disable GSSAPI authentication for API requests.

Choices:

  • false ← (default)

  • true

use_proxy

boolean

A flag to enable or disable the use of a proxy for API requests.

Choices:

  • false

  • true ← (default)

validate_certs

boolean

A flag to enable or disable SSL certificate validation for API requests.

Choices:

  • false

  • true ← (default)

Examples

- name: Create a minimal SSB table
  cloudera.services.ssb_table:
    project_id: "12345"
    table_name: "my_table"
    type: "TABLE"
    metadata:
      columns:
        - name: "id"
          type: "INT"
        - name: "name"
          type: "STRING"
    state: present

- name: Create a table with transformation code
  cloudera.services.ssb_table:
    project_id: "12345"
    table_name: "transformed_table"
    type: "TABLE"
    metadata:
      columns:
        - name: "id"
          type: "INT"
    transform_code: "SELECT * FROM source_table"
    state: present

- name: Delete a table by name
  cloudera.services.ssb_table:
    project_id: "12345"
    table_name: "my_table"
    state: absent

- name: Delete a table by id
  cloudera.services.ssb_table:
    project_id: "12345"
    id: 42
    state: absent

- name: Update a table by deleting and rebuilding
  cloudera.services.ssb_table:
    project_id: "12345"
    table_name: "my_table"
    type: "TABLE"
    metadata:
      columns:
        - name: "id"
          type: "INT"
        - name: "updated_column"
          type: "STRING"
    update_enabled: true
    state: present

- name: Prevent updates to an existing table
  cloudera.services.ssb_table:
    project_id: "12345"
    table_name: "my_table"
    type: "TABLE"
    metadata:
      columns:
        - name: "id"
          type: "INT"
    update_enabled: false
    state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

sdk_out

string

Returns the captured REST API log.

Returned: when supported

sdk_out_lines

list / elements=string

Returns a list of each line of the captured REST API log.

Returned: when supported

table

dictionary

The table details.

Returned: when state is present

created_at

string

The timestamp when the table was created.

Returned: when available

id

integer

The unique identifier of the table.

Returned: always

metadata

dictionary

Dictionary of metadata for the table.

Returned: when available

project_id

string

The project identifier this table belongs to.

Returned: when available

table_name

string

The name of the table.

Returned: always

transform_code

string

Optional transformation code for the table.

Returned: when available

transform_code_base64

boolean

Whether the transform_code is base64 encoded.

Returned: when available

type

string

The type of the table.

Returned: always

Authors

  • Webster Mudge (@wmudge)