stadtluzernio.budibase.execute_a_query (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 query given its name.

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

Usage examples

Scanned by Steampunk Spotter

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

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

Inputs

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

query:
    description: The name of the query 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 query conditions
    suboptions:
      pagination:
        description: For supported query types (currently on REST) pagination can be performed
          using these properties.
        suboptions:
          limit:
            description: The number of rows to return per page.
            type: int
          page:
            description: The page which has been returned from a previous query.
            type: str
        type: dict
      parameters:
        description: This contains the required parameters for the query, this depends
          on query type, setup and bindings.
        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
    query_info:
      description: Query info (_id, name, schema, ...)
      type: dict
  description: App info, query info and content from selectet row
  returned: always
  type: dict