As noted above, to build a database connector, you must set the
| 1 small blue.png | |||
| Select your required database type from the dropdown field: |  | Complete other settings as normal and save your changes. As soon as you save this page, the database connector setup wizard is launched. | 2 small blue.png |
Add a name for this query and choose the type of entity that you're querying: |  | The For general information about these settings, please see our main Connector Builder section - the same principles apply to both endpoints and queries. | 1 small blue.png | |
| General details are added in the top panel, with query configuration in the tabs below: |  | 2 small blue.png | ||
In the top panel, set the direction of this query as appropriate - i.e. does it modify data (send) or retrieve data (receive)? |  | For general information about these settings, please see our main Connector Builder section - the same principles apply to both endpoints and queries. | 3 small blue.png | |
Move down to the authentication tab and toggle the DB user pass authentication method on for this query: |  | For general information about these settings, please see our main Connector Builder section - the same principles apply to both endpoints and queries. | 4 small blue.png | |
If you want to add variables for inclusion in this query (so values can be provided at runtime and injected into queries), select the query variables tab and add the required variables: |  | For examples of how variables might be used, see Working with database queries. For general information about these settings, please see our main Connector Builder section - the same principles apply to both endpoints and queries. | 5 small blue.png | |
Select the query tab to add your database query - for example: |  | This is where you define your query using the required syntax for your database (in this case, it's MySQL). Syntax highlighting is included (verification is not currently available - any issues with queries will be reported at runtime). Standard syntax is used for the database type however, there are some Patchworks conventions to consider - please see Working with database queries for more information. | 6 small blue.png | |
If your query includes parameters for pagination (LIMIT and OFFSET), select the pagination tab to define the required values to be passed in - for example: |  | Limit offset is the most commonly used pagination method for databases. For general information on this topic please see our main Connector Builder section - the same principles apply to both endpoints and queries. | 7 small blue.png | |
| Having created all your required queries, you can go on to add instances of this connector (for use in process flows) in the normal way: |  | When prompted, choose the
| 8 small blue.png |
