Skip to content

GIT - DATA SINK

Description

The GIT data sink is designed to distribute data by committing it to a Git repository. This method is particularly useful for version control and collaboration, allowing for the tracking of data changes over time. The GIT data sink supports various configuration options to customize the data distribution process, including specifying the Git repository URL, branch, path prefix, and authentication details.

Config

REQUIRED

Config Parameters

Name Description
password The password for authentication with the Git repository. This is a required parameter.
gitURL The URL of the Git repository where the data will be committed. This is a required parameter.
branch The branch in the Git repository where the data will be committed. This is a required parameter.
pathPrefix The path prefix within the Git repository where the data will be committed. This is a required parameter.
username The username for authentication with the Git repository. This is a required parameter.
discriminator A unique identifier for the data being committed, used to differentiate between different data distributions. This is an optional parameter.

Config Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<apiroConf version="1" xmlns="http://apiro.com/apiro/v1/root">
    <loadOrder>25</loadOrder>
    <dataSinks>
        <dataSink name="ASX_GIT_SINK" definition="GIT">
            <config>
                <![CDATA[
                    {
                      "password": "${SYS:APIRO_GITHUB_PW}",
                      "gitURL": "https://github.com/redapiro/apiro_engine_test_feeds.git",
                      "branch": "demo7",
                      "pathPrefix": "/internal/internal_asx20_pricing.xlsx",
                      "username": "apirobot",
                      "discriminator" : "ASX20_Prices"
                    }
                ]]>
            </config>
        </dataSink>
    </dataSinks>
</apiroConf>

Common Mistakes

  • Incorrect Authentication Details: Ensure that the username and password parameters are correct and have the necessary permissions to commit data to the specified Git repository.
  • Invalid Git URL: Verify that the gitURL parameter is a valid URL and points to an existing Git repository.
  • Non-Existent Branch: Confirm that the branch parameter specifies a branch that exists in the Git repository.
  • Incorrect Path Prefix: Ensure that the pathPrefix parameter correctly points to the desired location within the Git repository where the data should be committed.
  • Permission Issues: If you encounter permission errors, check that the Git repository's access controls allow the specified user to commit data.