Skip to content

Reference Docs

MatillionClient

Source code in pymatillion/matillion.py 
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
class MatillionClient:
    def __init__(
        self, base_url, username, password, project_group_name=None, project_name=None
    ):
        self.base_url = base_url
        self.username = username
        self.password = password
        self.project_group_name = project_group_name
        self.project_name = project_name
        self._valid_attributes = False
        self._headers = None

    def _ensure_attributes(self, *args):
        attributes_to_check = set(args)
        invalid_attributes = []
        for attr in attributes_to_check:
            if (getattr(self, attr) is None) or (not getattr(self, attr)):
                invalid_attributes.append(attr)
        if invalid_attributes:
            raise ValueError(f'Undefined attributes: {",".join(invalid_attributes)}')
        else:
            self._valid_attributes = True

    def _set_headers(self):
        self._headers = {"Content-Type": "application/json"}

    def _api_request(
        self, http_method, *args, is_json=True, **kwargs
    ) -> requests.Response:
        """
        Make an API Request.

        Args:
            http_method (str) : HTTP method to use when making API request.
            args : Variable length list of strings to construct endpoint path.
            is_json (bool) : Set to False if payload/response is not JSON data.
            kwargs : Arbitrary keyword arguments to construct request payload.

        Returns:
            requests.Response : Response object.
        """

        api_request = getattr(requests, http_method)
        api_path = f'{self.base_url}/rest/v1/{"/".join(args)}'
        if is_json:
            if len(kwargs) == 1 and "json" in kwargs:
                response = api_request(
                    api_path,
                    headers=self._headers,
                    auth=(self.username, self.password),
                    json=kwargs["json"],
                )
            else:
                response = api_request(
                    api_path,
                    headers=self._headers,
                    auth=(self.username, self.password),
                    json=kwargs,
                )
        else:
            if len(kwargs) == 1 and "data" in kwargs:
                response = api_request(
                    api_path,
                    headers=self._headers,
                    auth=(self.username, self.password),
                    data=kwargs["data"],
                )
            else:
                response = api_request(
                    api_path,
                    headers=self._headers,
                    auth=(self.username, self.password),
                    data=kwargs,
                )
        try:
            response.raise_for_status()
        except Exception:
            logger.error(f"Response content:\n{response.content}")
            raise
        return response

    def list_project_groups(self) -> List[str]:
        """
        Retrieve Project Groups within the Matillion instance.

        Returns:
            Project Groups (list) : A list of strings with names of Project Groups.
        """
        self._ensure_attributes(BASE_URL, USERNAME, PASSWORD)
        return self._api_request(API_GET, "group").json()

    def list_projects(self) -> List[str]:
        """
        Retreive Projects within the specified Project Group of Matillion instance.

        Returns:
            Project Names (list) : A list of strings with names of Projects.
        """
        self._ensure_attributes(BASE_URL, USERNAME, PASSWORD, PROJECT_GROUP_NAME)
        return self._api_request(
            API_GET, "group", "name", self.project_group_name, "project"
        ).json()

    def list_jobs(
        self, project_name: str = None, version: str = DEFAULT_VERSION
    ) -> List[str]:
        """
        Retrieve jobs within the specified version of the Matillion project.

        Args:
            project_name (str): Name of the Matillion project.
            version: (str), optional. Default value : default.
        Returns:
            Matillion Jobs (list): A list of of strings with names of the Matillion jobs.
        """
        self._ensure_attributes(
            BASE_URL, USERNAME, PASSWORD, PROJECT_GROUP_NAME, PROJECT_NAME
        )
        return self._api_request(
            API_GET,
            "group",
            "name",
            self.project_group_name,
            "project",
            "name",
            project_name if project_name else self.project_name,
            "version",
            "name",
            version,
            "job",
        ).json()

    def run_job(
        self,
        job_name: str,
        job_variables: dict = {},
        grid_variables: dict = {},
        project_name: str = None,
        version: str = DEFAULT_VERSION,
    ) -> Dict:
        """
        Run Matillion job within the specified project, for the specified version.

        Args:
            job_name (str): Name of the Matillion job intended to run.
            job_variables (dict): Dictionary of Matillion job variables.
            grid_variables (dict): Dictionary of Matillion grid variables.
            project_name (str): Name of the Matillion project.
            version: (str), optional. Default value : default.
        Returns:
            dict : Sample response can be found at https://documentation.matillion.com/docs/2475544#server-response
        """
        self._ensure_attributes(
            BASE_URL, USERNAME, PASSWORD, PROJECT_GROUP_NAME, PROJECT_NAME
        )
        body = {"scalarVariables": job_variables, "gridVariables": grid_variables}
        return self._api_request(
            API_POST,
            "group",
            "name",
            self.project_group_name,
            "project",
            "name",
            project_name if project_name else self.project_name,
            "version",
            "name",
            version,
            "job",
            "name",
            job_name,
            "run",
            json=body,
        ).json()

    def get_task_details(self, task_id: int, project_name: str = None) -> Dict:
        """
        Retrieve details for the specified executed task id.
        Args:
            task_id (int): ID of the executed Matillion task.
            project_name (str): Name of the Matillion project.
        Returns:
            dict : Sample response can be found at https://documentation.matillion.com/docs/2972278
        """
        self._ensure_attributes(
            BASE_URL, USERNAME, PASSWORD, PROJECT_GROUP_NAME, PROJECT_NAME
        )
        return self._api_request(
            API_GET,
            "group",
            "name",
            self.project_group_name,
            "project",
            "name",
            project_name if project_name else self.project_name,
            "task",
            "id",
            str(task_id),
        ).json()

    def delete_project(self, project_name: str, version: str = DEFAULT_VERSION) -> Dict:
        """
        Delete Matillion project. If version is specified then delete specified project version.

        Args:
            project_name (str): Name of the Matillion project.
            version: (str), optional. Default value : default.
        Returns:
            dict : Sample response can be found at https://documentation.matillion.com/docs/2949951#deleting-resources
        """
        self._ensure_attributes(
            BASE_URL, USERNAME, PASSWORD, PROJECT_GROUP_NAME, PROJECT_NAME
        )
        return self._api_request(
            API_POST,
            "group",
            "name",
            self.project_group_name,
            "project",
            "name",
            project_name if project_name else self.project_name,
            "version",
            "name",
            version,
            "delete",
        ).json()

    def delete_job(
        self, job_name: str, project_name: str = None, version: str = DEFAULT_VERSION
    ) -> Dict:
        """
        Delete Matillion job within the specified version of the project.

        Args:
            job_name: (str), required. Name of the Matillion job to delete.
            project_name: (str), optional. Name of the Matillion project.
            version: (str), optional. Default value : default.
        Returns:
            Dict[Any, Any] : Sample response can be found at https://documentation.matillion.com/docs/2949951#deleting-resources
        """
        self._ensure_attributes(
            BASE_URL, USERNAME, PASSWORD, PROJECT_GROUP_NAME, PROJECT_NAME
        )
        return self._api_request(
            API_POST,
            "group",
            "name",
            self.project_group_name,
            "project",
            "name",
            project_name if project_name else self.project_name,
            "version",
            "name",
            version,
            "job",
            "name",
            job_name,
            "delete",
        ).json()

delete_job(job_name, project_name=None, version=DEFAULT_VERSION)

Delete Matillion job within the specified version of the project.

Parameters:

Name Type Description Default
job_name str

(str), required. Name of the Matillion job to delete.

 required
project_name str

(str), optional. Name of the Matillion project.

 None
version str

(str), optional. Default value : default.

 DEFAULT_VERSION

Returns:

Type Description
Dict

Dict[Any, Any] : Sample response can be found at https://documentation.matillion.com/docs/2949951#deleting-resources
Source code in pymatillion/matillion.py 
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
def delete_job(
    self, job_name: str, project_name: str = None, version: str = DEFAULT_VERSION
) -> Dict:
    """
    Delete Matillion job within the specified version of the project.

    Args:
        job_name: (str), required. Name of the Matillion job to delete.
        project_name: (str), optional. Name of the Matillion project.
        version: (str), optional. Default value : default.
    Returns:
        Dict[Any, Any] : Sample response can be found at https://documentation.matillion.com/docs/2949951#deleting-resources
    """
    self._ensure_attributes(
        BASE_URL, USERNAME, PASSWORD, PROJECT_GROUP_NAME, PROJECT_NAME
    )
    return self._api_request(
        API_POST,
        "group",
        "name",
        self.project_group_name,
        "project",
        "name",
        project_name if project_name else self.project_name,
        "version",
        "name",
        version,
        "job",
        "name",
        job_name,
        "delete",
    ).json()

delete_project(project_name, version=DEFAULT_VERSION)

Delete Matillion project. If version is specified then delete specified project version.

Parameters:

Name Type Description Default
project_name str

Name of the Matillion project.

 required
version str

(str), optional. Default value : default.

 DEFAULT_VERSION

Returns:

Name Type Description
dict Dict

Sample response can be found at https://documentation.matillion.com/docs/2949951#deleting-resources
Source code in pymatillion/matillion.py 
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
def delete_project(self, project_name: str, version: str = DEFAULT_VERSION) -> Dict:
    """
    Delete Matillion project. If version is specified then delete specified project version.

    Args:
        project_name (str): Name of the Matillion project.
        version: (str), optional. Default value : default.
    Returns:
        dict : Sample response can be found at https://documentation.matillion.com/docs/2949951#deleting-resources
    """
    self._ensure_attributes(
        BASE_URL, USERNAME, PASSWORD, PROJECT_GROUP_NAME, PROJECT_NAME
    )
    return self._api_request(
        API_POST,
        "group",
        "name",
        self.project_group_name,
        "project",
        "name",
        project_name if project_name else self.project_name,
        "version",
        "name",
        version,
        "delete",
    ).json()

get_task_details(task_id, project_name=None)

Retrieve details for the specified executed task id.

Parameters:

Name Type Description Default
task_id int

ID of the executed Matillion task.

 required
project_name str

Name of the Matillion project.

 None

Returns:

Name Type Description
dict Dict

Sample response can be found at https://documentation.matillion.com/docs/2972278
Source code in pymatillion/matillion.py 
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
def get_task_details(self, task_id: int, project_name: str = None) -> Dict:
    """
    Retrieve details for the specified executed task id.
    Args:
        task_id (int): ID of the executed Matillion task.
        project_name (str): Name of the Matillion project.
    Returns:
        dict : Sample response can be found at https://documentation.matillion.com/docs/2972278
    """
    self._ensure_attributes(
        BASE_URL, USERNAME, PASSWORD, PROJECT_GROUP_NAME, PROJECT_NAME
    )
    return self._api_request(
        API_GET,
        "group",
        "name",
        self.project_group_name,
        "project",
        "name",
        project_name if project_name else self.project_name,
        "task",
        "id",
        str(task_id),
    ).json()

list_jobs(project_name=None, version=DEFAULT_VERSION)

Retrieve jobs within the specified version of the Matillion project.

Parameters:

Name Type Description Default
project_name str

Name of the Matillion project.

 None
version str

(str), optional. Default value : default.

 DEFAULT_VERSION

Returns:

Type Description
List[str]

Matillion Jobs (list): A list of of strings with names of the Matillion jobs.
Source code in pymatillion/matillion.py 
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
def list_jobs(
    self, project_name: str = None, version: str = DEFAULT_VERSION
) -> List[str]:
    """
    Retrieve jobs within the specified version of the Matillion project.

    Args:
        project_name (str): Name of the Matillion project.
        version: (str), optional. Default value : default.
    Returns:
        Matillion Jobs (list): A list of of strings with names of the Matillion jobs.
    """
    self._ensure_attributes(
        BASE_URL, USERNAME, PASSWORD, PROJECT_GROUP_NAME, PROJECT_NAME
    )
    return self._api_request(
        API_GET,
        "group",
        "name",
        self.project_group_name,
        "project",
        "name",
        project_name if project_name else self.project_name,
        "version",
        "name",
        version,
        "job",
    ).json()

list_project_groups()

Retrieve Project Groups within the Matillion instance.

Returns:

Type Description
List[str]

Project Groups (list) : A list of strings with names of Project Groups.
Source code in pymatillion/matillion.py 
101
102
103
104
105
106
107
108
109
def list_project_groups(self) -> List[str]:
    """
    Retrieve Project Groups within the Matillion instance.

    Returns:
        Project Groups (list) : A list of strings with names of Project Groups.
    """
    self._ensure_attributes(BASE_URL, USERNAME, PASSWORD)
    return self._api_request(API_GET, "group").json()

list_projects()

Retreive Projects within the specified Project Group of Matillion instance.

Returns:

Type Description
List[str]

Project Names (list) : A list of strings with names of Projects.
Source code in pymatillion/matillion.py 
111
112
113
114
115
116
117
118
119
120
121
def list_projects(self) -> List[str]:
    """
    Retreive Projects within the specified Project Group of Matillion instance.

    Returns:
        Project Names (list) : A list of strings with names of Projects.
    """
    self._ensure_attributes(BASE_URL, USERNAME, PASSWORD, PROJECT_GROUP_NAME)
    return self._api_request(
        API_GET, "group", "name", self.project_group_name, "project"
    ).json()

run_job(job_name, job_variables={}, grid_variables={}, project_name=None, version=DEFAULT_VERSION)

Run Matillion job within the specified project, for the specified version.

Parameters:

Name Type Description Default
job_name str

Name of the Matillion job intended to run.

 required
job_variables dict

Dictionary of Matillion job variables.

 {}
grid_variables dict

Dictionary of Matillion grid variables.

 {}
project_name str

Name of the Matillion project.

 None
version str

(str), optional. Default value : default.

 DEFAULT_VERSION

Returns:

Name Type Description
dict Dict

Sample response can be found at https://documentation.matillion.com/docs/2475544#server-response
Source code in pymatillion/matillion.py 
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
def run_job(
    self,
    job_name: str,
    job_variables: dict = {},
    grid_variables: dict = {},
    project_name: str = None,
    version: str = DEFAULT_VERSION,
) -> Dict:
    """
    Run Matillion job within the specified project, for the specified version.

    Args:
        job_name (str): Name of the Matillion job intended to run.
        job_variables (dict): Dictionary of Matillion job variables.
        grid_variables (dict): Dictionary of Matillion grid variables.
        project_name (str): Name of the Matillion project.
        version: (str), optional. Default value : default.
    Returns:
        dict : Sample response can be found at https://documentation.matillion.com/docs/2475544#server-response
    """
    self._ensure_attributes(
        BASE_URL, USERNAME, PASSWORD, PROJECT_GROUP_NAME, PROJECT_NAME
    )
    body = {"scalarVariables": job_variables, "gridVariables": grid_variables}
    return self._api_request(
        API_POST,
        "group",
        "name",
        self.project_group_name,
        "project",
        "name",
        project_name if project_name else self.project_name,
        "version",
        "name",
        version,
        "job",
        "name",
        job_name,
        "run",
        json=body,
    ).json()