Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Add Persister Configuration

Overview

This page provides the steps on how to add a persister configuration.

The persister configuration is written in a YAML format. The INSERT and UPDATE queries for each table are added in prepared statement format, followed by the JSON paths of values that have to be inserted/updated.

For example, for a table named studentinfo with id, name, age, and marks fields, the following configuration will get the persister ready to insert data into the studentinfo table -

serviceMaps:
 serviceName: student-management-service
 mappings:
 - version: 1.0
   description: Persists student details in studentinfo table
   fromTopic: save-student-info
   isTransaction: true
   queryMaps:
       - query: INSERT INTO studentinfo( id, name, age, marks) VALUES (?, ?, ?, ?);
         basePath: Students.*
         jsonMaps:
          - jsonPath: $.Students.*.id

          - jsonPath: $.Students.*.name

          - jsonPath: $.Students.*.age

          - jsonPath: $.Students.*.marks

Steps

Add Persister Configuration

  1. Fork the configs repo. Ignore if done already. Clone the configs repo in the local environment.

  1. Persister configurations for all modules are present under the egov-persister folder. Create a file by the name of btr-persister.yml (or any other name) under the egov-persister folder.

  2. Add the below content to it -

Run Persister Locally

  1. Import all the core-services projects as Maven projects into your IDE. It is assumed that you have already cloned the DIGIT code locally.

  2. Modify the application.properties file in the egov-persister project and set the following property:

Note: You can set a comma-separated list of files as the value of the above property. If you are running multiple services locally, then this has to be a comma-separated list of persister config files. Make sure you always give the absolute path.

  1. Make sure the Spring DB configurations and Flyway config reflect the same database as what has been set in the module itself. Otherwise, we will see failures in the persister code.

  1. Make sure Kafka is running locally. Now, go ahead and run the EgovPersistApplication from the IDE. Check the console to make sure it is listening to the right topics as configured in your module's application.properties file.

The persister is now ready for use.

Deploy Persister Configuration

Note: The steps below are for when you deploy your code to the DIGIT env, not for local development. You may choose to do this when you build and deploy.

  1. Push the code to the appropriate branch from which your environment will read it.

  2. Navigate to your fork of the DIGIT-DevOps repository. Under the deploy-as-code/helm/environments directory, find the deployment Helm chart that was used to deploy DIGIT.

  3. In the deployment helm chart (which was used to set up the DIGIT environment), find "egov-persister". Find the "persist-yml-path" property and add the path to your new persister file here.

    In the snippet below, file:///work-dir/configs/egov-persister/birth-module-developer-guide.yml

  1. Raise a PR to the appropriate branch of the DevOps repo (master, in egov case), which was forked/used to create the deployment. Once that is merged, restart the indexer service in your environment so it will pick up this new config for the module.

PreviousImplement Kafka Producer & ConsumerNextEnable Signed Audit

Last updated

Was this helpful?