stadtluzernio.budibase.search_for_rows (1.0.6) — module

Install collection

Install with ansible-galaxy collection install stadtluzernio.budibase:==1.0.6

Add to requirements.yml

  collections:
    - name: stadtluzernio.budibase
      version: 1.0.6

Description

Get the value a single table given its name.

You may provide a section label to limit the search to that table section.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

---
- name: Get all rows from table inventory in stadtluzernio app with status published
  stadtluzernio.budibase.search_for_rows:
    hostname: BUDIBASE_HOST
    token: BUDIBASE_TOKEN
    app: BUDIBASE_APP
    query: BUDIBASE_QUERY
    status: published

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get all rows with colume os_famoly_name value equal windows from table inventory in stadtluzernio app with status published
  stadtluzernio.budibase.search_for_rows:
    hostname: BUDIBASE_HOST
    token: BUDIBASE_TOKEN
    app: BUDIBASE_APP
    query: BUDIBASE_QUERY

    status: published
    conditions:
      query:
        equal:
          os_family_name: windows

Inputs

    
app:
    description: The name of the app which this request is targeting.
    required: true
    type: str

table:
    description: The name of the table which this request is targeting.
    required: true
    type: str

token:
    description:
    - Token to authenticate Budibase.
    - Ansible should never log or display this value.
    type: str

status:
    choices:
    - published
    - development
    default: published
    description: App status published / development
    type: str

hostname:
    description:
    - Budibase Hostname (FQDN).
    type: str

conditions:
    description: Use table conditions
    suboptions:
      bookmark:
        description: If retrieving another page, the bookmark from the previous request
          must be supplied.
        type: str
      limit:
        description: The maximum number of rows to return, useful when paginating, for
          internal tables this will be limited to 1000, for SQL tables it will be 5000.
        type: int
      paginate:
        default: false
        description: Enables pagination, by default this is disabled.
        type: bool
      query:
        description: Table query
        suboptions:
          empty:
            description: Searches for rows which do not contain the specified column.
              The object should simply contain keys of the column names, these can map
              to any value.
            type: dict
          equal:
            description: Searches for rows that have a column value that is exactly the
              value set.
            type: dict
          fuzzy:
            description: A fuzzy search, only supported by internal tables.
            type: dict
          notEmpty:
            description: Searches for rows which have the specified column.
            type: dict
          notEqual:
            description: Searches for any row which does not contain the specified column
              value.
            type: dict
          oneOf:
            description: Searches for rows which have a column value that is any of the
              specified values. The format of this must be columnName -> [value1, value2].
            type: dict
          range:
            description: Searches within a range, the format of this must be columnName
              -> [low, high].
            type: dict
          string:
            description: A map of field name to the string to search for, this will look
              for rows that have a value starting with the string value.
            type: dict
        type: dict
      sort:
        description: A set of parameters describing the sort behaviour of the search.
        suboptions:
          column:
            description: The name of the column by which the rows will be sorted.
            type: str
          order:
            choices:
            - ascending
            - descending
            description: The order of the sort, by default this is ascending.
            type: str
          type:
            description: Defines whether the column should be treated as a string or as
              numbers when sorting.
            type: str
        type: dict
    type: dict

validate_certs:
    default: true
    description: If false, SSL certificates will not be validated
    type: bool

Outputs

json:
  'contains:':
    app_info:
      description: App info (_id, name, status, ...)
      returned: success
      type: dict
    content:
      description: Content from selectet rows
      elements: dict
      returned: success
      type: list
    table_info:
      description: Table info (_id, name, schema, ...)
      type: dict
  description: App info, table info and content from selectet row
  returned: always
  type: dict