DB Engine | Circuit | Qntrl | Online Help | Execute SQL query in a database

DB Engine

DB Engine state enables a connection with the database hosted on a private or local network and executes the defined SQL query in the database. 


Prerequisite
  • An active Bridge agent. Refer here to install and configure Bridge.

  • Create the necessary Credentials for the applications to be connected by DB Engine.

For more details about the DB Engine module in Bridge, the keys, and its description click here.

 

Use Case Example: In the employee onboarding process, once the recruitment is complete, the HR department updates the database with the newly recruited employee's information. DB state is employed to feed the system with these employee details. By executing a DB query, you can create an entry in the organization's legacy database, thereby recording the employee's information. Additionally, DB state enables HR to retrieve the details of any required employees.

Builder View

For associating a DB Task to a circuit:

  1. In Builder View, drag and drop the DB Engine state from the left pane into your circuit or click the required DB Engine state in your circuit.

  2. Under the Configuration tab, update the common state field attributes.

  3. The Bridge ID field should capture the details of the bridge to be used for this task. Click and select the required bridge from the drop-down list.  

  4. Under Add Configuration, in Credential Name field, click and select the credential from the dropdown list. The Credential IDs of all the credentials created for the DB Engine module type will be displayed in the list.

  5. Under Query Message, fill in the following fields:

    1. Database - Enter the name of the connecting database in which the query has to be executed.

    2. Query - Enter the query that has to be executed in the database.

    3. Port - Enter the port in which the MySQL server is running. The default port is 3306.

    4. Query Timeout - Specify the time limit (in seconds), within which the query must be executed.

    5. Host - Enter the hostname of the machine in which the database query has to be executed. Enter the hostname as localhost, if the query is executed on the same Bridge-installed machine.

    6. Database Type - Select the database type from the dropdown list.

    7. Connection Timeout - Specify the time limit (in seconds), within which the connection to the specified server must be made.

  6. For error handling, you have the option to choose and configure error handling settings. To learn more, check Error Handling in circuit states.
  7. The the Input/Output tab has to be filled with the Input Path, Output Path, and Result Path. To learn more about I/O paths, click here.        

Code view

In Code View, the JSON to configure the DB Engine state to pass a query and retrieve data from a database table is given below:

"Add User in Legacy Database": {
   "type": "db_engine",
   "next": "End",
   "bridge_id": "bridge-employee onboarding",
   "payload": {
      "credential_id": "db_cred_2",
         "query": "INSERT INTO user_record values('John Mathew', 'john.mathew@zylkermail.com','CA');",
     "query_timeout": 100,
      "host": "localhost",
      "database_type": "MySQL",
      "connection_timeout": 100,
     "port": 3306,
   "database_name": "user_db"
  }
}







    Access your files securely from anywhere

      Zoho CRM Training Programs

      Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

      Zoho CRM Training
        Redefine the way you work
        with Zoho Workplace

          Zoho DataPrep Personalized Demo

          If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

          Zoho CRM Training

            Create, share, and deliver

            beautiful slides from anywhere.

            Get Started Now


              Zoho Sign now offers specialized one-on-one training for both administrators and developers.

              BOOK A SESSION









                                            You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                                Manage your brands on social media

                                                  Zoho Desk Resources

                                                  • Desk Community Learning Series


                                                  • Digest


                                                  • Functions


                                                  • Meetups


                                                  • Kbase


                                                  • Resources


                                                  • Glossary


                                                  • Desk Marketplace


                                                  • MVP Corner


                                                  • Word of the Day


                                                    Zoho Marketing Automation

                                                      Zoho Sheet Resources

                                                       

                                                          Zoho Forms Resources


                                                            Secure your business
                                                            communication with Zoho Mail


                                                            Mail on the move with
                                                            Zoho Mail mobile application

                                                              Stay on top of your schedule
                                                              at all times


                                                              Carry your calendar with you
                                                              Anytime, anywhere




                                                                    Zoho Sign Resources

                                                                      Sign, Paperless!

                                                                      Sign and send business documents on the go!

                                                                      Get Started Now




                                                                              Zoho TeamInbox Resources



                                                                                      Zoho DataPrep Resources



                                                                                        Zoho DataPrep Demo

                                                                                        Get a personalized demo or POC

                                                                                        REGISTER NOW


                                                                                          Design. Discuss. Deliver.

                                                                                          Create visually engaging stories with Zoho Show.

                                                                                          Get Started Now









                                                                                                              • Related Articles

                                                                                                              • DB Engine

                                                                                                                DB Engine is used to connect with the database in the client's machine or client's network and perform READ/INSERT/UPDATE operations in the database. The DB Engine configured in bridge can be utilized in the following two distinct modules within ...
                                                                                                              • SSH Engine

                                                                                                                SSH Engine module in Bridge is used to perform actions in clients network/client's machine by executing a command/script in Linux/UNIX OS. Prerequisite While creating Credentials for SSH Engine, choose the credential type as SSH. Click here to learn ...
                                                                                                              • PowerShell Engine

                                                                                                                In Bridge, the PowerShell Engine module is used to perform actions in any Windows machines in the client's network using PowerShell script. Prerequisite While creating Credentials, select the type Powershell and provide the User Name and Password of ...
                                                                                                              • Task Engine

                                                                                                                In Qntrl, while public APIs can be configured and executed directly through Webhooks, the client's internal APIs that are exposed only to the local network can be executed using the Task Engine module in Bridge. The Task Engine configured in bridge ...
                                                                                                              • Task Engine

                                                                                                                Circuit's Task Engine state is used to connect with other applications and access APIs from a closed space. To retrieve data from a private network, the required API must be accessed from the local machine's network for the required conditions. ...
                                                                                                                Wherever you are is as good as
                                                                                                                your workplace

                                                                                                                  Resources

                                                                                                                  Videos

                                                                                                                  Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                  eBooks

                                                                                                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                  Webinars

                                                                                                                  Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                  CRM Tips

                                                                                                                  Make the most of Zoho CRM with these useful tips.



                                                                                                                    Zoho Show Resources