Skip to main content

Cyware Orchestrate

SQL

App Vendor: SQL

App Category: IT Services

Connector Version: 1.0.0

API Version: 1.0.0

About App

The SQL app helps you to run SQL queries on SQL databases such as MySQL, PostgreSQL, and Microsoft SQL Server.

The SQL app is configured with Orchestrate to perform the following actions:

Action Name

Description

Run Query

This action executes a SQL query.

Configuration Parameters

The following configuration parameters are required for the SQL app to communicate with the SQL enterprise application. The parameters can be configured by creating instances in the app.

Parameter

Description

Field Type

Required/Optional

Comments

SQL Database Type

Enter the database type to connect with.

Example:

"MySQL"

Text

Required

Allowed values:

  • PostgreSQL

  • Microsoft SQL Server

  • MySQL

Username

Enter the username to connect to the database.

Example:

"john.doe"

Text

Required

Password

Enter the password to connect to the database.

Password

Required

Host

Enter the hostname or the IP address of the database.

Example:

  • "db-hostname.domain.tld"

  • "10.1.1.2"

Text

Required

Port

Enter the port used to connect to the database.

Example:

1433

Integer

Required

Database

Enter the name of the database to connect to.

Example:

"projectdatabase"

Text

Required

Action: Run Query

This action executes a SQL query.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Query

Enter the SQL query to execute.

Example:

  • "SELECT * FROM gendata WHERE alphanumeric = 'ZXS11JJH5ZA'"

  • "SHOW TABLES IN mysql"

Text

Required

Example Request

[
    {
        "query": "SELECT * FROM gendata WHERE alphanumeric = 'ZXS11JJH5ZA'"     
    }
]
[
    {
        "query": "SHOW TABLES IN mysql"    
    }
]
[
    {
        "query": "SHOW DATABASES"     
    }
]
[
    {
         "query": "INSERT INTO gendata (name,text,region,country,numberrange,
         alphanumeric) VALUES ('Test User2','222testing values string pass via 
         playbook', 'South America', 'USA','99','ZXS11JJH5ZA')"        
    }
]
[
    {
        "query": "

UPDATE gendata SET name = 'Updated Name', text = 'updated text 
        via playbook' WHERE alphanumeric ='ZXS11JJH5ZA'

"     
    }
]