Search Knowledge Base by Keyword

PowerShell: Oracle MySQL

< Back

Overview

This connector reads MySQL database tables, the same source as the Oracle MySQL connector, by running a PowerShell script on a Windows host instead of connecting from the ReadyWorks application server. MySQL itself is the open-source relational database owned by Oracle, commonly found under internal web applications, open-source management tooling and appliance back ends.

The connection names the MySQL server, a port (the default is 3306), an optional source database, optional credentials, and a temporary working path on the Windows host where the script writes its output during processing. Each job’s Data Selection field carries the SQL statement to run, and the result set is written to the named staging table. The script CX_MYSQL.ps1 performs the connection and the query.

The reason to choose this connector over the direct Oracle MySQL connector is network position. When the MySQL server is reachable only from inside a segment where a Windows ETL host already sits, running the query from that host avoids opening a database port to the ReadyWorks application server. The trade-off is a narrower job form: this connector exposes nine job fields, with no Allow Empty Table, no Append New Data to Existing Tables, no Request Limit and no unique key or sort settings.

The connector is inbound only. It reads query results and writes staging tables, and it issues no writes to the source database.

NOTE: windows_only is set on this connector. The ReadyWorks ETL host that runs these jobs has to be a Windows machine with PowerShell, and it needs whatever MySQL client library the script depends on installed and network reachability to the database server. A Linux-hosted ReadyWorks deployment cannot run this connector.

Connector Properties

Property Value
Identifier RWS_MYSQL
Name Powershell: Oracle MySQL
Description Connector for accessing MySQL database tables using Powershell script.
Job Types Inbound Only
Order 810
Enabled Yes
Locked Yes
Block Update No
Single Authentication No
Windows Only Yes
Connector Version 2025-11-06
Hooks None
Additional Job Fields None
Image

Authentication Methods

One method ships: a PowerShell connection to a MySQL server from the Windows ETL host.

Method Identifier Base Method Script Order Enabled Config Fields
User / Password RWS_MYSQL_d6eb2b8ecc RWS_MYSQL_d6eb2b8ecc CX_MYSQL.ps1 10 Yes 6

NOTE: Source DB, Username and Password are all optional here, where the direct Oracle MySQL connector requires all three. A connection with those fields blank will save cleanly and fail at run time, so fill them in unless you have a specific reason not to.

NOTE: Source DB is stored in the auth_data_node column, which is labelled Authentication Data Node on other connectors. The value is the database name.

Method 1: User / Password (RWS_MYSQL_d6eb2b8ecc)

MySQL User Password Connection

User / Password runs CX_MYSQL.ps1 against the server in Source Server on the port in Source Server Port (the default is 3306). Username, Password and Source DB are all optional on this form, so a connection can be saved with any of them blank. Server Temporary Working Path is required and names the directory on the Windows host where the script stages its output.

Connection Configuration Fields (6)

Order Label Type Required Default Max Len Tooltip
10 Source Server text Yes 255 Enter source server of the db
20 Source Server Port text Yes 3306 5 Enter port number of the source server
30 Server Temporary Working Path text Yes storage/etl5 255 Enter path where temporary files are stored during data processing (exclude starting and ending backslash)
40 Username text No 1024 Tooltip for Username
50 Password password No 64000 Tooltip for Password
200 Source DB text No 255 The source DB

Authentication Configuration

Inbound Job Fields Enabled (9)

These are the job-level settings exposed for a PowerShell MySQL extract. Data Selection holds the SQL statement.

Order Label Type Required Default Tooltip
10 Job Description text Yes Enter description of the Job
20 Job Schedule lookup Yes Daily Select frequency Job should run
30 Enabled radio Yes Yes Choose if Job is enabled
70 Destination Table text Yes Enter name of the destination table
80 Data Identity text No Enter identity of the Job
90 Data Selection textarea No Enter connector specific data selection command of the Job
130 Fields to Index text No Enter fields to index
230 Data Processing text No
560 Order text Yes Enter order of the Job

Inbound Job Templates (1)

One inbound template ships. Read the issues below before creating a connection, because the shipped job is enabled and incomplete.

# Job Description Destination Table API End Point Enabled What It Pulls
1 Job job Not set Yes A placeholder job with no SQL statement, writing to a staging table named job. It carries no Data Selection, no query and no meaningful description, and exists as a shell for you to fill in.

Job Template Configuration

Settings

Setting Value
Order 10
Enabled Yes
Job Schedule Daily (15 1 * * *)
Destination Table job
Data Identity job
Allow Empty Table Yes
Append Files to Same Destination Table No
Append New Data to Existing Tables No
Use Unparsed Data No
Convert UUID-Keyed Objects to Rows No
Ignore XML Attributes No
Log Raw API Calls No
Method Type GET
Body Data Sending Method JSON Encoded Data

Outbound Job Templates (0)

This connector ships no outbound templates and does not support outbound jobs.

Tags: