Search.setIndex({"alltitles": {"0.5.0 - 2024-10-25": [[6, null]], " API Reference": [[0, null]], " Dependencies": [[8, null]], " User Guide": [[13, null]], " FAQ": [[10, null]], " Tools": [[12, null]], " Developer Guide": [[9, null]], "Added": [[7, "added"]], "Bug Fixes": [[3, "bug-fixes"]], "Changelog": [[1, null]], "Create a Simple Error": [[13, "create-a-simple-error"]], "Creating a Release": [[9, "creating-a-release"]], "Documentation": [[5, "documentation"], [6, "documentation"]], "Error Objects": [[13, "error-objects"]], "Error Parameter(s) without description": [[13, "error-parameter-s-without-description"]], "Error with detailed Parameter(s)": [[13, "error-with-detailed-parameter-s"]], "Error-Reporting-Python": [[11, null]], "Example Usages": [[12, "example-usages"]], "Feature": [[5, "feature"], [6, "feature"]], "Features": [[2, "features"], [4, "features"]], "Fixes": [[6, "fixes"]], "Generating an error-code data file": [[12, "generating-an-error-code-data-file"]], "How to get Help": [[12, "how-to-get-help"]], "Install the library": [[13, "install-the-library"]], "Internal": [[6, "internal"], [7, "internal"]], "Links & References": [[13, "links-references"]], "One of the release steps failed (Partial Release)": [[9, "one-of-the-release-steps-failed-partial-release"]], "Parsing the error definitions in a python file(s)": [[12, "parsing-the-error-definitions-in-a-python-file-s"]], "Prepare the Release": [[9, "prepare-the-release"]], "Refactoring": [[5, "refactoring"], [7, "refactoring"]], "Refactorings": [[6, "refactorings"]], "Run Time Dependencies": [[8, "run-time-dependencies"]], "Specify Multiple Mitigations": [[13, "specify-multiple-mitigations"]], "Summary": [[2, "summary"], [3, "summary"], [4, "summary"], [5, "summary"]], "Test Dependencies": [[8, "test-dependencies"]], "The release failed during pre-release checks": [[9, "the-release-failed-during-pre-release-checks"]], "Tooling": [[13, "tooling"]], "Triggering the Release": [[9, "triggering-the-release"]], "Unreleased": [[7, null]], "Usage": [[13, "usage"]], "What to do if the release failed?": [[9, "what-to-do-if-the-release-failed"]], "code": [[13, "code"]], "error-reporting-python 0.1.0, released 2021-12-13": [[2, null]], "error-reporting-python 0.2.0, released 2022-03-28": [[3, null]], "error-reporting-python 0.3.0, released 2023-03-27": [[4, null]], "exasol-error-reporting 0.4.0, released 2023-09-27": [[5, null]], "message": [[13, "message"]], "mitigations": [[13, "mitigations"]], "parameters": [[13, "parameters"]]}, "docnames": ["api", "changes/changelog", "changes/changes_0.1.0", "changes/changes_0.2.0", "changes/changes_0.3.0", "changes/changes_0.4.0", "changes/changes_0.5.0", "changes/unreleased", "dependencies", "developer_guide/developer_guide", "faq", "index", "tools", "user_guide/user_guide"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1}, "filenames": ["api.rst", "changes/changelog.md", "changes/changes_0.1.0.md", "changes/changes_0.2.0.md", "changes/changes_0.3.0.md", "changes/changes_0.4.0.md", "changes/changes_0.5.0.md", "changes/unreleased.md", "dependencies.rst", "developer_guide/developer_guide.rst", "faq.rst", "index.rst", "tools.rst", "user_guide/user_guide.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": 9, "0": 1, "1": 1, "13": 13, "14": 4, "16": 5, "17": 5, "19": 5, "2": 1, "22": 5, "22004": 13, "27": 6, "3": [1, 2, 6], "33": 6, "4": 1, "5": 1, "52": 7, "6": 2, "8": 3, "9": [8, 13], "A": 13, "For": [9, 13], "In": [2, 3, 4, 12], "No": 13, "Not": 13, "The": [12, 13], "To": 9, "abov": 8, "achiev": 9, "action": [5, 9], "ad": [2, 6], "add": [2, 5, 6], "addit": 2, "addition": 13, "allow": [2, 13], "alphabet": 13, "alphanumer": 13, "also": 5, "an": [2, 3, 6, 13], "api": [5, 11], "appropri": [2, 9], "ar": [11, 13], "argument": 13, "ask": 11, "asserterror": 3, "assist": 12, "attent": 13, "autom": 9, "avail": 13, "been": 5, "begin": 9, "best": 11, "bracket": 13, "builder": 2, "built": 13, "c": 13, "can": [2, 9, 12, 13], "case": 3, "catalog": 13, "caus": 3, "cd": 9, "changelog": 9, "check": [7, 13], "ci": 9, "cli": [5, 11], "code": [2, 3, 4, 5], "come": 12, "command": [9, 12, 13], "compliant": [12, 13], "contain": [2, 13], "contribut": 11, "control": 7, "crawler": 5, "creat": 6, "curli": 13, "defin": [2, 13], "definit": 13, "delet": [9, 13], "depend": [6, 7, 11], "descript": 11, "detail": [9, 11], "dev": 13, "develop": 11, "devic": 13, "dictionari": 13, "document": 13, "doe": 6, "doubl": 13, "e": 13, "easier": 5, "ec": 12, "either": 13, "elimin": 3, "enabl": 7, "enough": 13, "entri": 12, "environ": 11, "error": [6, 7], "error1": 13, "error2": 13, "error3": 13, "error4": 13, "exa": 13, "exaerror": [2, 13], "exampl": [9, 11, 13], "exasol": [2, 13], "except": 6, "extinguish": 13, "extract": 13, "f": 13, "failur": 13, "faq": 11, "featur": 11, "few": 13, "finegrain": 7, "finish": 9, "fire": 13, "first": 2, "fit": 5, "fix": [9, 13], "flexibl": 13, "flood": 13, "follow": [9, 13], "format": [3, 13], "framework": 8, "frequent": 11, "from": [5, 9, 13], "function": 13, "further": [9, 13], "furthermor": 3, "ga": 13, "git": 9, "github": [6, 9], "given": 13, "go": 13, "got": 9, "gpl": 8, "guid": 11, "ha": 5, "halon": 13, "have": 3, "help": 11, "hint": [2, 13], "how": [11, 13], "human": 13, "i": [3, 9, 12, 13], "import": 13, "includ": 13, "initi": 2, "instead": 3, "instruct": 11, "interrupt": 9, "introduc": 13, "invalid": 3, "issu": [6, 9], "its": 11, "java": 13, "json": 12, "keep": 13, "lead": 9, "librari": [2, 12], "licens": 8, "line": [12, 13], "list": 13, "local": 9, "lua": 13, "main": 12, "major": 9, "make": [6, 13], "manag": 13, "manual": 9, "merg": 9, "messag": 2, "mind": 13, "minor": 9, "mit": 8, "mitig": 2, "modul": 13, "more": [2, 5, 13], "must": 9, "name": [2, 3, 4, 5, 6, 12, 13], "need": [9, 13], "nest": 3, "new": 9, "next": 9, "note": 5, "nox": 9, "number": [9, 13], "obei": 13, "onc": 9, "one": 2, "onli": 13, "order": [5, 12], "origin": 9, "out": 13, "output": 7, "packag": [5, 9], "package_root": 12, "paramet": [6, 9], "pars": [5, 13], "parser": 5, "part": 11, "patch": 9, "pip": 13, "placehold": 13, "pleas": 13, "poetri": 5, "point": 12, "pr": 9, "practic": 11, "prepar": [2, 4], "process": 9, "project": [2, 4, 6, 7, 11, 13], "provid": [2, 11, 13], "prysk": 8, "psf": 8, "publish": 9, "pull": 9, "purpos": 8, "push": 9, "py": [5, 12], "pypi": [4, 5, 9], "pytest": 8, "python": [5, 6, 8, 13], "qrw": 13, "questsion": 11, "rais": 6, "readm": 5, "recover": 13, "redo": 9, "refer": 11, "relock": [6, 7], "remot": 9, "remov": 5, "renam": 5, "replac": [9, 13], "report": [12, 13], "request": 9, "resourc": 11, "respect": 13, "rework": [5, 6], "room": 13, "run": 9, "satisfi": 13, "scenario": 9, "schema": 13, "scheme": 5, "sda1": 13, "section": [9, 13], "see": [9, 13], "server": 13, "set": [3, 11, 12], "setup": [2, 5], "sever": 13, "ship": 11, "short": 13, "should": [2, 13], "solut": 9, "some": 12, "someth": 13, "space": 13, "sql": 13, "start": [9, 13], "static": 13, "string": 13, "structur": 2, "subcommand": 12, "successfulli": 9, "support": [6, 7], "sure": [6, 13], "syntax": 11, "tag": [9, 13], "take": 13, "templat": [6, 9], "test": 13, "thei": 13, "thi": [2, 3, 4, 9, 11, 13], "thrown": 3, "tool": [5, 11], "toolbox": 7, "trivial": 13, "type": 7, "understand": 11, "uniform": 2, "unreleas": 1, "up": 11, "updat": [5, 6, 7, 9], "upload": 9, "us": [12, 13], "usag": 11, "user": 11, "util": 11, "v": 13, "valid": 13, "valu": 13, "valueerror": 3, "via": 13, "w": 13, "wa": 9, "warn": [3, 13], "we": [3, 4], "where": 13, "which": [9, 11, 13], "work": [12, 13], "workflow": [7, 9], "x": 9, "y": 9, "yet": 9, "yml": 9, "you": [12, 13], "z": [9, 13], "z0": 13}, "titles": [" API Reference", "Changelog", "error-reporting-python 0.1.0, released 2021-12-13", "error-reporting-python 0.2.0, released 2022-03-28", "error-reporting-python 0.3.0, released 2023-03-27", "exasol-error-reporting 0.4.0, released 2023-09-27", "0.5.0 - 2024-10-25", "Unreleased", " Dependencies", " Developer Guide", " FAQ", "Error-Reporting-Python", " Tools", " User Guide"], "titleterms": {"": [12, 13], "0": [0, 2, 3, 4, 5, 6, 8, 9, 10, 12, 13], "001a": 10, "002": 9, "004": 13, "004a6": 10, "004c": 10, "005": 13, "006": 10, "007": 10, "008l": 9, "01": 10, "017": 9, "024": 9, "027": 9, "03": [3, 4], "041": 9, "043": 9, "045a1": 8, "045c": 8, "047": 8, "049v4": 8, "04a5": 9, "04c": 9, "05": 9, "061": 10, "067": [9, 10], "068c": 9, "07": 13, "072": 10, "073a6": 13, "073l": 9, "082": 9, "085": 9, "085h": 10, "09": [5, 8, 9, 10], "092": 9, "094": 9, "098a1": 8, "0a8": 10, "0em": [0, 8, 9, 10, 12, 13], "0l": [8, 9], "0v14h": 0, "0v14h3": 0, "0v2h1": 0, "0z": [10, 13], "0zm10": 13, "0zm2": 8, "0zm5": 0, "0zm7": 8, "1": [0, 2, 8, 9, 10, 12, 13], "10": 6, "103": 10, "109": 10, "11": [0, 8, 9, 10], "112": [0, 12], "115": 10, "11a1": 10, "12": [0, 2, 9], "122": 8, "123": 13, "125": 8, "127": 9, "13": [2, 10, 12], "132": 10, "133l4": 8, "138": [0, 10, 12], "13zm6": 10, "14": [9, 12], "141": 12, "142": [9, 13], "14h11v1": 0, "15": 10, "157": 9, "159z": 9, "15h1": 12, "16": [0, 8, 9, 10, 12, 13], "161a": 10, "163": 9, "164": 9, "169": 10, "16v2": 9, "171": 8, "182": 10, "184": 10, "187a1": 10, "195l": 10, "1h12": 12, "2": [0, 3, 8, 9, 10, 12, 13], "201": 8, "2021": 2, "2022": 3, "2023": [4, 5], "2024": 6, "205": 10, "206l": 9, "207": [9, 10], "209": 9, "215": 12, "215l2": 12, "216": 9, "216l4": 8, "216v5": 8, "22": [10, 12], "23": 9, "24": 10, "245": 10, "245c8": 10, "248": [8, 10], "249": 9, "25": [0, 6, 8, 9, 12], "258": 10, "25a": [0, 10, 12], "25a1": 0, "25c": [0, 12], "25h": 0, "25h12": 12, "25v": 0, "25v10": 12, "25v11h": 0, "25v2": 12, "25v8": 0, "25zm1": 12, "25zm5": 0, "25zm7": 12, "26": 10, "262": 10, "264": 10, "27": [4, 5, 10], "271": 8, "275": 12, "276": 10, "277": 10, "28": [3, 9], "282v2": 9, "28a": 12, "296": 9, "298": 9, "2h5v": 0, "3": [0, 4, 8, 9, 12, 13], "304a4": 9, "307": 10, "312": 9, "313": 10, "314": 8, "315l": 9, "316a5": 9, "326": 12, "328": 9, "329": 10, "331": 12, "332": 8, "337a": 9, "339": 10, "33a": 9, "33c": 9, "34": 10, "342": 10, "345c": 9, "369": 10, "372c0": 8, "377": 10, "384": 9, "392": 8, "392a1": 8, "398zm9": 10, "3a": 12, "3h": 0, "3v1": 0, "3z": 0, "4": [0, 5, 8, 9, 10, 13], "404": 9, "42": 10, "423a1": 9, "423v2": 9, "427": 10, "431": 13, "432": 13, "432z": 8, "432zm6": 8, "433": 9, "436": 10, "44": 12, "448": 10, "448l": 9, "462": 9, "463c0": 9, "47": 10, "482": 9, "489": 10, "492": 9, "495": 9, "498": [9, 13], "4a2": 10, "5": [0, 6, 8, 9, 10, 12, 13], "503": 10, "513": 10, "514": 10, "514l": 8, "514l7": 8, "514v6": 8, "518": 9, "51a": 9, "51a1": 9, "525a1": 10, "525c": 10, "53l": 12, "53zm1": 12, "54": 8, "561": 13, "567": 9, "595": 10, "596": 9, "598": 9, "5a": [0, 12], "5a1": 12, "5a2": 13, "5a6": 10, "5c": [10, 12], "5c0": [0, 12], "5h": 12, "5h14v1": 0, "5h14v3h1": 0, "5h2v": 0, "5h2v3": 0, "5h3a": 12, "5h3v": 0, "5h4": 0, "5z": 12, "5zm": 0, "6": [10, 12, 13], "612": 10, "624": 8, "625": 8, "63": 8, "637": 10, "64a4": 9, "64l": 9, "64v": 9, "661": 10, "662": 10, "673": 9, "677l8": 8, "677v5": 8, "67c": 10, "683a": 8, "683v8": 8, "685a": 8, "685l8": 8, "692": 10, "696c": 9, "69l": 8, "6a4": 9, "6a5": 9, "6c0": 9, "7": [8, 10], "701": 10, "714": 9, "717": 9, "72": 12, "725": 10, "734": 12, "734l5": 12, "74": 10, "749": [10, 12], "75": [0, 8, 9, 10, 12, 13], "752": 9, "755": 8, "756": [8, 10], "758": 8, "75a": [0, 12], "75a1": [0, 12], "75c0": 12, "75c2": 0, "75h": 0, "75v": 0, "75v10": 12, "75v2h3v": 0, "75v4": 0, "75v5h1": 0, "76": 9, "767": 9, "784": [0, 12], "786": 9, "8": [0, 8, 10, 12, 13], "802": 9, "818a1": 9, "827": 9, "82c0": 9, "83": 10, "832": 9, "832c": 10, "845": 10, "849": 10, "863": 10, "872": 8, "875": 8, "878": 8, "89": 8, "8a": 12, "8a8": 10, "8zm8": 10, "9": [9, 10], "902": 9, "92": [9, 10], "923": 9, "929": 9, "933": 9, "951c0": 8, "952": 10, "96": 10, "965": 10, "966": [0, 9, 12], "969": 10, "977c6": 10, "99": 13, "993": 9, "996": 9, "999": 13, "One": 9, "The": 9, "ad": 7, "an": 12, "api": 0, "aria": [0, 8, 9, 10, 12, 13], "bug": 3, "changelog": 1, "check": 9, "class": [0, 8, 9, 10, 12, 13], "code": [12, 13], "cpu": 0, "creat": [9, 13], "d": [0, 8, 9, 10, 12, 13], "data": 12, "definit": 12, "depend": 8, "descript": 13, "detail": 13, "develop": 9, "do": 9, "document": [5, 6], "dure": 9, "error": [2, 3, 4, 5, 11, 12, 13], "exampl": 12, "exasol": 5, "fail": 9, "faq": 10, "featur": [2, 4, 5, 6], "file": 12, "fix": [3, 6], "gener": 12, "get": 12, "guid": [9, 13], "height": [0, 8, 9, 10, 12, 13], "help": 12, "hidden": [0, 8, 9, 10, 12, 13], "how": 12, "instal": 13, "intern": [6, 7], "librari": 13, "link": 13, "m0": [10, 12], "m10": 13, "m5": 9, "m6": 0, "m8": 8, "messag": 13, "mitig": 13, "multipl": 13, "object": 13, "octicon": [0, 8, 9, 10, 12, 13], "packag": 8, "paramet": 13, "pars": 12, "partial": 9, "path": [0, 8, 9, 10, 12, 13], "person": 13, "pre": 9, "prepar": 9, "python": [2, 3, 4, 11, 12], "question": 10, "refactor": [5, 6, 7], "refer": [0, 13], "releas": [2, 3, 4, 5, 9], "report": [2, 3, 4, 5, 11], "run": 8, "sd": [0, 8, 9, 10, 12, 13], "simpl": 13, "specifi": 13, "step": 9, "summari": [2, 3, 4, 5], "svg": [0, 8, 9, 10, 12, 13], "termin": 12, "test": 8, "time": 8, "tool": [9, 12, 13], "trigger": 9, "true": [0, 8, 9, 10, 12, 13], "unreleas": 7, "usag": [12, 13], "user": 13, "version": [0, 8, 9, 10, 12, 13], "viewbox": [0, 8, 9, 10, 12, 13], "what": 9, "width": [0, 8, 9, 10, 12, 13], "without": 13}})