Contributing to OLake

For Contributing to OLake, refer the guide here (detailed Contributing guide comming soon)

A good start will be to explore:

• first good issues

See the issues and if its looks interesting enough to you, comment below them and one of our maintainers will get in touch with you.

You can also refer to the projects section in GitHub or contributing sheet to see who all are working on which issues

Refer here to build mongodb replicaset.

info

Please join OLake slack community's #contributing-to-olake channel for all the information regarding contributions. Join OLake Community Slack here.

Debugging OLake

Assumptions

1. You are using VSCode to run OLake locally.
2. You have cloned the project in a suitable directory.

git clone git@github.com:datazip-inc/olake.git

caution

Please read getting started with OLake guide before proceeding to follow along this guide

Steps to Debug

1. Make a directory .vscode (inside OLake project, at root location) if not already created.
2. Create a file named launch.json inside the .vscode directory and paste the beflow config.

.vscode/launch.json

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Launch Go Code",
            "type": "go",
            "request": "launch",
            "program": "{PATH_TO_UPDATE}/drivers/mongodb/main.go",
            "mode": "auto",
            "args": [
                "sync",
                "--config",
                "{PATH_TO_UPDATE}/drivers/mongodb/examples/config.json",
                "--catalog",
                "{PATH_TO_UPDATE}/drivers/mongodb/examples/catalog.json",
                "--destination",
                "{PATH_TO_UPDATE}/drivers/mongodb/examples/writer.json",
                // "--state",
                // "{PATH_TO_UPDATE}/drivers/mongodb/examples/state.json",
            ]
        }
    ]
}

Params:

key	value(s)
mode	auto, debug
args	sync , discover

Update PATH_TO_UPDATE with the location where OLake project lives inside your system. For example:

"program": "/Users/john/Desktop/projects/olake/drivers/mongodb/main.go",
...
    "--config",
    "/Users/john/Desktop/projects/olake/drivers/mongodb/examples/config.json",
...          

Now, setup debug points in the codebase and click "Launch Go Code".