||
Skip to end of metadata
Go to start of metadata

Output MySQL event adapter helps to dump the output events to a MySQL database. It is used as an output event adapter.

Prerequisites

Follow the steps below to set up the prerequisites before starting the configuration.

  1. Download MySQL JDBC connector for Java, and add it to <PRODUCT_HOME>/repository/components/lib/ directory.
  2. Create a datasource, as the MySQL event adapter uses Carbon datasources. 

Configuring output MySQL event Adapter

You can configure the output MySQL event adapter using the management console or using a configuration file. 

Configure using the management console 

The steps below explain how to configure output MySQL event adapter using the management console. This deploys the event adapter in the <PRODUCT_HOME>/repository/deployment/server/outputeventadaptors/ directory.

  1. Log in to product's management console, and click Configure.
  2. Click Output Event Adaptors in the Event Processor Configs menu, and then click Add Output Event Adaptor.
  3. Enter mysql_adapter for Event Adaptor Name, select mysql for Event Adaptor Type, and enter the name of the created datasource
    as shown in the below example. 

    create output MySQL event adapter

  4. Click Add Event Adaptor.

Configure using a configuration file

Follow the instructions below to configure output MySQL event adapter using a configuration file.

  1. Create an XML file with the following output MySQL event adapter configurations. Output event adapter implementation must start with <outputEventAdaptor> as the root element.

    <outputEventAdaptor name="mysql_adaptor" statistics="disable"
      trace="disable" type="mysql" xmlns="http://wso2.org/carbon/eventadaptormanager">
      <property name="datasource.name">mysqldatasrc1</property>
    </outputEventAdaptor>
  2. Add the XML file to the <PRODUCT_HOME>/repository/deployment/server/outputeventadaptors/ directory. Since hot deployment is supported in the product, you can simply add/remove output event adapter configuration files to deploy/undeploy output event adapters to/from the server.

After an adapter is successfully added, it gets added to the list of adapters displayed under Event Processor Configs in the Configure menu of the product's management console. Click Edit to change its configuration and redeploy it. This opens an XML-based editor allowing you to edit the event adapter configurations from the UI.  Do your modifications and click Update. You can also delete it, enable/disable statistics or enable/disable tracing on it using the provided options in the UI.

Configuring output MySQL event adapter message properties

The configured output event adapters are used in event formatters. With output event adapter message properties, event formatters are able to extract data from event streams and format the output events. Message properties specific to output event adapters of the mysql type can be configured as follows.

  1. Log into the BAM Management Console. For detailed instructions, see Running the Product.
  2. In the Main tab, click Event Streams to open the AvailableEvent Streams page.
  3. Click the Outflows link of the event stream to which the relevant output event adapter is connected. As a result, Event Out-Flows (<Output_Event_Adapter_Name>) opens.
  4. Click on the relevant event builder name to open the Event Formatter Details page.
    output MySQL event adapter message propertiesThe message properties of a mysql output event adapter are described below. Change the property values as required.

    PropertyDescription
    Composite key columnsColumn names used in uniqueness check for updates. When an event arrives, the table is searched using the values of these columns and then the matching events are updated. This is not applicable for insert-only mode.
    Execution ModeExecution mode of the output event. The supported modes are insert-only and insert or update. In insert or update modes, event gets inserted if it doesn't already exist in the table. Otherwise, an existing event in the table is updated.
    Table NameName of the database table.
    Output Event TypeThe outgoing event type to be mapped. The output MySQL event adapter supports only map type mappings.
  • No labels