informatica.infacore.setup

informatica.infacore.setup(config: dict)

Sets up the user environment for INFACore.

Parameters:

config (dict) –

A dictionary that contains the login, compute engine, and ecosystem related configuration details.

• config[‘login’]A dictionary containing the login credentials and POD details.

  • config[‘login’][‘username’]: str, the IICS user name.

  • config[‘login’][‘password’]: str, the IICS password.

  • config[‘login’][‘env_type’] : str, ‘prod’ if your account is in the IICS production POD. Else, specify ‘test’.

  • config[‘login’][‘url’]: str, the login URL. Mandatory if the ‘env_type’ is ‘test’.

  • config[‘login’][‘region’]: str, the region where your IICS account resides. Mandatory if the ‘env_type’ is ‘prod’.

  • config[‘login’][‘cloud_provider’]: str, the cloud provider where your IICS account resides. Mandatory if the ‘env_type’ is ‘prod’.

• config[‘compute_engine’]: A dictionary containing the details of the compute engine.

  • config[‘compute_engine’][‘type’]: str, Allowed values are local and remote. Specify ‘local’ if INFACore and the compute engine are on the same machine. Else, specify ‘remote’.

  • config[‘compute_engine’][‘install’]: bool, mandatory key for the local compute engine. Specify True if you want to install the compute engine locally. Specify False if the compute engine is already installed.

  • config[‘compute_engine’][‘runtime_env_name’]: str, mandatory key for the remote compute engine. Specify the runtime environment name for the remote compute engine.

  • config[‘compute_engine’][‘agent_name’]: str, optional key for remote compute engine. The runtime_env_name is considered as the agent name by default. If your agent name is different, specify the name.

• config[‘ecosystem’]: A dictionary containing the details of the ecosystem where you want to stage the data.

  • config[‘ecosystem’][‘type’]: str, Allowed value are “Databricks Delta”, “Microsoft Fabric OneLake”.

  • config[‘ecosystem’][‘staging’]: dict, placeholder for staging attributes.

  • config[‘ecosystem’][‘staging’][‘connection_name’]: str, the connection name corresponding to the ecosystem where you want to stage the data.

Examples

# Example 1 - Setting up the local compute engine

>>> import informatica.infacore as ic
>>> user_config = {
        "login": {
            "username": "infacore",
            "password": "INFACore!rocks",
            "env_type": "prod",
            "cloud_provider": "dm",
            "region": "us"
        },
        "compute_engine": {
            "type": "local",
            "install" : True
        }
    }
>>> ic.setup(config=user_config)

# Example 2 - Setting up the remote compute engine with the Databricks Delta ecosystem

>>> import informatica.infacore as ic
>>> user_config = {
        "login": {
            "username": "infacore",
            "password": "INFACore!rocks",
            "env_type": "prod",
            "cloud_provider": "dm",
            "region": "us"
        },
        "compute_engine": {
            "type": "remote",
            "runtime_env_name" : "icagentcluster",
            "agent_env_name" : "icagent01"
        },
        "ecosystem" : {
            "type" : "Databricks Delta"
            "staging" : {
                "connection_name" : "Databricks INFACore"
            }
        }
    }
>>> ic.setup(config=user_config)

Raises:

InfacoreClientErrorMessages.mandatory_setup_config_missing – It is mandatory that you provide the config dictionary for the setup() function.