diff --git a/README.md b/README.md index 1a49f28..61c917d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +SQLMock Logo + # SQL Mock: Python Library for Mocking SQL Queries with Dictionary Inputs [![PyPI version](https://img.shields.io/pypi/v/sql-mock.svg)](https://pypi.org/project/sql-mock/) diff --git a/SQLMock_logo.png b/SQLMock_logo.png new file mode 100644 index 0000000..687694a Binary files /dev/null and b/SQLMock_logo.png differ diff --git a/docs/objects.inv b/docs/objects.inv index bc320c7..f9f2657 100644 Binary files a/docs/objects.inv and b/docs/objects.inv differ diff --git a/docs/py-modindex.html b/docs/py-modindex.html index b333ca3..82abdb5 100644 --- a/docs/py-modindex.html +++ b/docs/py-modindex.html @@ -106,7 +106,7 @@

Python Module Index

- sql_mock + sql_mock diff --git a/docs/searchindex.js b/docs/searchindex.js index 5ce2116..971f340 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["faq", "getting_started/installation", "getting_started/quickstart", "index", "modules", "robots", "sql_mock", "sql_mock.bigquery", "sql_mock.clickhouse", "usage/bigquery/examples", "usage/bigquery/index", "usage/bigquery/settings", "usage/clickhouse/examples", "usage/clickhouse/index", "usage/clickhouse/settings", "usage/dbt", "usage/default_values", "usage/defining_table_mocks", "usage/examples", "usage/result_assertion", "usage/your_sql_query_to_test"], "filenames": ["faq.md", "getting_started/installation.md", "getting_started/quickstart.md", "index.rst", "modules.rst", "robots.txt", "sql_mock.rst", "sql_mock.bigquery.rst", "sql_mock.clickhouse.rst", "usage/bigquery/examples.md", "usage/bigquery/index.rst", "usage/bigquery/settings.md", "usage/clickhouse/examples.md", "usage/clickhouse/index.rst", "usage/clickhouse/settings.md", "usage/dbt.md", "usage/default_values.md", "usage/defining_table_mocks.md", "usage/examples.md", "usage/result_assertion.md", "usage/your_sql_query_to_test.md"], "titles": ["FAQ", "Installation", "Quickstart", "Welcome to SQL Mock\u2019s documentation!", "sql_mock", "<no title>", "sql_mock package", "sql_mock.bigquery package", "sql_mock.clickhouse package", "Example: Testing Subscription Counts in BigQuery", "BigQuery", "Settings", "Example: Testing Subscription Counts in ClickHouse", "Clickhouse", "Settings", "Use with dbt", "Default values", "Defining table mocks", "Examples", "Result assertion", "Your SQL query to test"], "terms": {"we": [0, 1, 2, 6, 15, 16, 17, 19, 20], "ar": [0, 1, 6, 15, 16, 17, 19, 20], "plan": 0, "add": [0, 1, 6], "more": [0, 2, 17, 19], "howev": 0, "you": [0, 1, 2, 6, 11, 14, 15, 16, 17, 18, 19, 20], "can": [0, 1, 2, 6, 15, 16, 17, 18, 19, 20], "still": 0, "There": [0, 17, 19, 20], "onli": [0, 6, 16, 17, 19, 20], "2": [0, 2, 3, 9, 12, 16, 17, 19], "thing": [0, 17], "need": [0, 1, 3, 6, 11, 14, 16, 17, 20], "first": 0, "inherit": [0, 6, 9, 12, 17], "from": [0, 1, 2, 6, 7, 8, 9, 12, 15, 17, 19, 20], "sql_mock": [0, 1, 2, 9, 12, 15, 17, 19], "table_mock": [0, 2, 9, 12, 15, 17, 19], "basemockt": [0, 6, 7, 8, 17], "That": 0, "implement": [0, 16], "_get_result": 0, "method": [0, 1, 2, 16, 17, 19, 20], "which": [0, 6, 15], "make": [0, 1, 15], "sure": [0, 1, 15], "fetch": 0, "result": [0, 2, 3, 6, 9, 12, 15, 17], "queri": [0, 2, 3, 6, 9, 12, 16, 17, 19], "e": [0, 2, 6, 17, 20], "g": [0, 2, 6, 17, 20], "produc": [0, 15], "self": 0, "_generate_queri": 0, "return": [0, 6], "list": [0, 6], "dictionari": [0, 2, 6, 7, 8, 20], "look": 0, "one": [0, 6, 16], "exist": 0, "client": 0, "librari": [0, 1, 3, 15], "see": 0, "how": [0, 2, 10, 13, 15, 16, 17, 19, 20], "thi": [0, 1, 2, 3, 6, 7, 8, 10, 13, 15, 17, 19, 20], "could": 0, "work": [0, 2, 15, 16], "bigquerymockt": [0, 2, 6, 7, 9, 15, 16, 17, 19], "might": 0, "set": [0, 3, 6, 10, 13], "well": [0, 17], "case": [0, 3, 16, 19, 20], "some": [0, 2, 17, 18, 20], "connect": [0, 11, 14], "avail": [0, 2], "within": [0, 6], "In": [0, 1, 2, 11, 14, 16, 19, 20], "order": [0, 6, 11, 14], "them": [0, 17, 20], "column": [0, 2, 6, 15, 16], "column_mock": [0, 2, 9, 12, 17, 19], "base": [0, 2, 6, 7, 8], "For": [0, 15, 16], "most": 0, "specifi": [0, 2, 16, 17, 20], "dtype": [0, 6, 7, 8], "pars": 0, "input": [0, 2, 3, 6, 15, 16, 17, 19, 20], "A": [0, 6, 15, 19], "good": 0, "practis": 0, "all": [0, 1, 2, 6, 16, 17], "import": [0, 1, 2, 9, 12, 15, 17, 19], "myfancedatabasecolumnmock": 0, "logic": [0, 16, 19], "overwrit": [0, 6, 17], "default": [0, 2, 3, 6, 7, 8, 9, 12, 15, 17, 19, 20], "behavior": 0, "so": 0, "here": [0, 15, 16], "pass": [0, 3, 16, 17], "int": [0, 2, 6, 7, 8, 9, 12, 15, 16, 17, 19, 20], "integ": [0, 7, 8], "string": [0, 2, 6, 7, 8, 9, 12, 15, 16, 17, 19, 20], "definit": [0, 16, 17], "folk": 0, "commun": 0, "just": 0, "feel": 0, "free": 0, "pr": 0, "repositori": 0, "start": [0, 2, 15], "implementd": 0, "basic": [0, 16], "happen": [0, 6], "don": [0, 2, 16], "t": [0, 2, 9, 12, 16, 19], "find": [0, 18], "luckili": 0, "easili": [0, 17], "those": [0, 14, 17, 19, 20], "tool": [0, 15], "provid": [0, 2, 3, 6, 14, 15, 16, 17], "The": [0, 1, 3, 6, 15, 16, 17, 20], "bigquerycolumnmock": [0, 6, 7], "write": [0, 3], "usual": [0, 17], "correct": [0, 16], "would": [0, 6], "later": 0, "cast": [0, 2, 6], "col": [0, 2, 9, 12, 15, 16, 17, 19, 20], "express": [0, 2], "replac": [0, 2, 6, 7, 8], "bigqueri": [0, 1, 3, 6, 11, 15, 17, 19], "myfancymissingcoltyp": 0, "fancymissingcoltyp": 0, "addit": [0, 16], "forget": 0, "pypi": 1, "us": [1, 2, 3, 6, 9, 10, 11, 12, 13, 14, 17, 19], "pip": 1, "upgrad": 1, "sql": [1, 2, 5, 6, 9, 10, 11, 12, 13, 14, 16, 17, 19], "mock": [1, 2, 5, 6, 9, 10, 11, 12, 13, 14, 19, 20], "clickhous": [1, 2, 3, 6, 14], "If": [1, 6], "modifi": 1, "sourc": [1, 3], "code": [1, 16], "depend": 1, "poetri": 1, "extra": [1, 7, 8], "conftest": 1, "py": [1, 17, 20], "file": [1, 6, 11, 15, 17, 20], "root": 1, "your": [1, 2, 3, 9, 12, 14, 16, 17, 19], "project": [1, 15], "follow": [1, 14, 19, 20], "line": 1, "register_assert_rewrit": 1, "allow": [1, 3, 16, 17], "get": [1, 2], "rich": 1, "comparison": [1, 6], "when": [1, 3, 6, 14, 17, 19, 20], "assert_equ": [1, 2, 6, 9, 12, 15, 19], "tabl": [1, 2, 6, 9, 12, 16, 19, 20], "instanc": [1, 2, 6, 14, 16, 17, 19, 20], "also": [1, 17, 19, 20], "icdiff": 1, "better": 1, "visibl": 1, "diff": 1, "fail": [1, 6], "test": [1, 3, 6, 10, 11, 13, 14, 16, 17, 19], "befor": 2, "dive": 2, "specif": [2, 10, 13, 16, 20], "databas": [2, 6, 15, 17], "scenario": [2, 3, 16], "let": [2, 11, 15, 16, 19, 20], "": [2, 6, 15, 16, 19, 20], "simplifi": [2, 3, 16], "exampl": [2, 3, 10, 13, 16, 19, 20], "behind": 2, "scene": 2, "have": [2, 11, 14, 17, 19], "an": [2, 16], "origin": [2, 6, 9, 12], "path": [2, 3, 6, 7, 8, 16, 17, 20], "query_for_result_t": [2, 17, 20], "select": [2, 9, 12, 17, 19, 20], "id": [2, 17, 20], "data": [2, 3, 6, 9, 12, 16, 17, 19, 20], "table1": [2, 17], "defin": [2, 3, 6, 7, 8, 9, 12, 16, 19, 20], "built": [2, 19], "type": [2, 3, 6], "includ": [2, 19], "date": [2, 6, 7, 8, 9, 12, 15, 19], "each": 2, "ha": [2, 15], "own": 2, "subclass": 2, "class": [2, 3, 6, 7, 8, 9, 12, 15, 16, 17, 19, 20], "fit": 2, "along": 2, "valu": [2, 3, 6], "our": [2, 19], "clickhousetablemock": [2, 6, 8, 12], "table_meta": [2, 3, 6, 9, 12, 17, 19], "table_ref": [2, 6, 9, 12, 16, 17, 19, 20], "1": [2, 3, 6, 9, 12, 16, 17, 19], "name": [2, 6, 7, 8, 15, 17], "peter": [2, 17], "result_t": [2, 17, 20], "query_path": [2, 6, 16, 17, 19, 20], "resultt": [2, 17, 20], "creat": [2, 3, 6, 9, 12, 16, 17], "repres": [2, 6], "row": [2, 6], "kei": [2, 6], "correspond": 2, "user_data": 2, "both": 2, "martin": 2, "3": [2, 3, 16], "input_table_mock": 2, "from_dict": [2, 6, 9, 12, 15, 16, 19], "from_mock": [2, 3, 6, 9, 12, 15, 16, 17, 19], "object": [2, 6], "gener": [2, 6], "re": [2, 9, 12, 16, 17, 19, 20], "input_data": [2, 6, 9, 12, 15, 16, 17, 19, 20], "refer": [2, 6], "common": 2, "cte": [2, 6, 19], "fill": [2, 16], "dummi": 2, "It": [2, 3, 6], "roughli": 2, "compar": [2, 6], "someth": 2, "like": [2, 6, 17], "WITH": [2, 19], "data__table1": 2, "AS": [2, 9, 12, 19, 20], "union": [2, 6], "final": [2, 6, 19], "expect": [2, 6, 9, 12, 15], "primari": 3, "purpos": 3, "i": [3, 6, 15, 17, 20], "model": [3, 6, 7, 8, 9, 12, 17, 19, 20], "user": [3, 5, 6, 8, 9, 12, 14, 16, 19, 20], "variou": [3, 16], "consist": [3, 16], "conveni": 3, "wai": [3, 16, 17, 19], "execut": 3, "without": 3, "process": [3, 6, 16], "massiv": 3, "amount": [3, 15], "instal": [3, 15], "recommend": [3, 17], "setup": [3, 16], "pytest": 3, "quickstart": 3, "faq": 3, "my": 3, "system": 3, "support": 3, "yet": 3, "want": [3, 6, 14, 17, 19, 20], "what": 3, "should": [3, 6, 7, 8], "do": [3, 19], "mocktabl": [3, 6, 17], "columnmock": [3, 6, 7, 8], "contribut": 3, "am": 3, "miss": 3, "field": [3, 6, 7, 8], "option": 3, "decor": [3, 6, 15, 16, 17], "call": 3, "jinja": [3, 6], "templat": [3, 6], "assert": [3, 6, 9, 12], "subscript": [3, 10, 13, 16, 19], "count": [3, 10, 13, 19], "index": 3, "modul": 3, "search": 3, "page": 3, "agent": 5, "sitemap": 5, "http": 5, "deeplcom": 5, "github": 5, "io": 5, "xml": 5, "decim": [6, 7, 8], "float": [6, 7, 8, 15], "bigqueryset": [6, 7], "google_application_credenti": [6, 7, 11], "model_config": [6, 7, 8], "model_field": [6, 7, 8], "boolean": [6, 8], "clickhousecolumnmock": [6, 8], "datetim": [6, 8, 9, 12, 15, 19], "datetime64": [6, 8], "clickhouseset": [6, 8], "host": [6, 8, 14], "password": [6, 8, 14], "port": [6, 8, 14], "none": [6, 7, 8], "nullabl": [6, 7, 8], "fals": [6, 7, 8], "str": [6, 7, 8], "indic": 6, "whether": 6, "null": 6, "cast_field": 6, "column_nam": 6, "to_sql": 6, "noinput": 6, "validationerror": 6, "dict": [6, 7, 8], "attribut": [6, 15], "col1": 6, "_sql_mock_data": 6, "store": 6, "automatci": 6, "instanti": 6, "sqlmockdata": 6, "_sql_mock_meta": 6, "metadata": [6, 7, 8], "mocktablemeta": 6, "as_sql_input": 6, "combin": [6, 16], "assert_cte_equ": [6, 19], "cte_nam": 6, "ignore_missing_kei": 6, "bool": [6, 7, 8], "ignore_ord": 6, "true": [6, 7, 8], "equal": 6, "paramet": 6, "against": 6, "present": 6, "argument": [6, 16, 17, 20], "ignor": 6, "classmethod": 6, "query_template_kwarg": [6, 20], "run": [6, 11, 14, 15, 19], "static": [6, 15], "hold": 6, "pair": 6, "render": [6, 20], "cl": 6, "basemodel": 6, "dure": 6, "avoid": 6, "collis": 6, "srting": 6, "format": 6, "classvar": [6, 7, 8], "configdict": [6, 7, 8], "configur": [3, 6, 7, 8], "conform": [6, 7, 8], "pydant": [6, 7, 8], "config": [6, 7, 8, 15], "fieldinfo": [6, 7, 8], "annot": [6, 7, 8], "requir": [6, 7, 8, 16], "about": [6, 7, 8], "map": [6, 7, 8, 19], "__fields__": [6, 7, 8], "v1": [6, 7, 8], "rendered_queri": 6, "last_queri": 6, "get_keys_from_list_of_dict": [], "replace_original_table_refer": [], "mock_tabl": [], "orign": [], "point": 11, "select_from_ct": [], "statement": [], "select_ct": [], "note": [6, 20], "validate_input_mock": [], "precis": [7, 8], "scale": [7, 8], "_case_sensit": [7, 8], "_env_prefix": [7, 8], "_env_fil": [7, 8], "dotenvtyp": [7, 8], "posixpath": [7, 8], "_env_file_encod": [7, 8], "_env_nested_delimit": [7, 8], "_secrets_dir": [7, 8], "baseset": [7, 8], "settingsconfigdict": [7, 8], "arbitrary_types_allow": [6, 7, 8], "case_sensit": [7, 8], "env_fil": [7, 8], "env_file_encod": [7, 8], "env_nested_delimit": [7, 8], "env_prefix": [7, 8], "forbid": [7, 8], "protected_namespac": [7, 8], "model_": [7, 8], "settings_": [7, 8], "secrets_dir": [7, 8], "validate_default": [7, 8], "arg": [7, 8], "kwarg": [7, 8], "sql_mock_clickhouse_": 8, "usert": [9, 12, 16, 19], "user_id": [9, 12, 15, 16, 19, 20], "user_nam": [9, 12, 16, 19], "mr": [9, 12, 16, 19], "subscriptiont": [9, 12, 16, 19], "subscription_id": [9, 12, 16, 19], "period_start_d": [9, 12, 19], "2023": [9, 12, 15, 19, 20], "9": [9, 12, 19], "5": [9, 12, 19], "period_end_d": [9, 12, 19], "subscriptioncountt": [9, 12], "subscription_count": [9, 12, 19], "left": [9, 12, 16, 19], "join": [9, 12, 16, 19], "group": [9, 12, 19], "BY": [9, 12, 19], "simul": [9, 12], "section": [10, 13, 17], "document": [10, 13], "ensur": [11, 16], "environ": [11, 14, 15], "variabl": [11, 14, 20], "correctli": [11, 16], "servic": 11, "account": 11, "while": 11, "sql_mock_clickhouse_host": 14, "sql_mock_clickhouse_us": 14, "sql_mock_clickhouse_password": 14, "sql_mock_clickhouse_port": 14, "enabl": 14, "upstream": [3, 17], "central": 17, "where": [17, 19, 20], "reus": [17, 20], "across": [16, 17], "goign": 17, "mention": 17, "referenc": 17, "product": 17, "pattern": 17, "schema": 17, "current": 17, "u": 17, "onc": [17, 20], "whatev": [17, 20], "wa": [17, 20], "read": 17, "detail": 17, "handl": 17, "found": 17, "folder": 18, "check": 19, "output": [6, 19], "given": [19, 20], "normal": 19, "full": 19, "lot": 19, "time": [16, 19], "complic": 19, "thei": [16, 19], "bunch": 19, "separ": 19, "step": [3, 16, 19], "unit": [15, 19], "abl": 19, "singl": [16, 19], "To": 19, "assum": [19, 20], "subscriptions_per_us": 19, "sub": 19, "ON": 19, "users_with_multiple_sub": 19, "test_queri": [16, 19], "multiplesubscriptionuserst": [16, 19], "now": 19, "differ": [15, 16, 19], "def": [15, 19], "test_model": 19, "subscriptions_per_user__expect": 19, "users_with_multiple_subs__expect": 19, "end_result__expect": 19, "end": 19, "multipl": [16, 20], "walk": 20, "through": 20, "cover": [15, 20], "bigquerytablemock": 20, "itself": 20, "advantag": 20, "after": 20, "mani": 20, "overwrid": 20, "sometim": 20, "dbt": [3, 20], "necessari": [15, 20], "context": 20, "created_at": 20, "creation_d": 20, "your_input_mock_inst": 20, "09": 20, "05": 20, "automat": 20, "_sql_dialect": 6, "dialect": 6, "leverag": 6, "sqlglot": 6, "sql_dialect": [], "sql_mock_data": 6, "default_input": [6, 16, 17], "serv": 6, "other": [6, 15, 16], "often": 16, "involv": 16, "repetit": 16, "sqlmock": [15, 16], "effect": [15, 16], "streamlin": 16, "By": 16, "reason": 16, "significantli": 16, "reduc": 16, "boilerpl": 16, "especi": 16, "deal": 16, "complex": 16, "explor": 16, "effici": 16, "level": [16, 17], "straightforward": 16, "particularli": 16, "function": 16, "oper": 16, "overrid": 16, "nala": 16, "No": 16, "accept": 16, "consid": [15, 16], "up": 16, "demonstr": 16, "happi": 16, "valid": 16, "syntax": 16, "minim": 16, "subset": 16, "certain": 16, "help": 16, "focu": 16, "numer": 16, "between": 16, "frequent": 16, "new": 16, "prevent": 16, "extens": 16, "refactor": 16, "ani": [], "skipvalid": 6, "empti": 16, "util": 3, "safe": 16, "chang": 16, "rest": 16, "stringarrai": [], "properti": 6, "arrai": [6, 7, 8], "constant": [], "use_quotes_for_cast": [6, 7, 8], "quot": 6, "inner_dtyp": [7, 8], "print_query_on_fail": 6, "print": 6, "consol": 6, "enhanc": [], "integr": [], "guid": 15, "introduct": 3, "prerequisit": 3, "manifest": 3, "seed": 3, "quick": 15, "build": 15, "ll": 15, "featur": 15, "json": 15, "latest": 15, "compil": 15, "python": 15, "initi": 15, "global": 15, "sqlmockconfig": 15, "set_dbt_manifest_path": 15, "offer": 15, "special": 15, "entiti": 15, "dbt_model_meta": 15, "suit": 15, "transform": 15, "model_nam": 15, "your_dbt_model_nam": 15, "yourdbtmodelt": 15, "dbt_source_meta": 15, "ideal": 15, "raw": 15, "consum": 15, "source_nam": 15, "your_source_nam": 15, "table_nam": 15, "your_source_t": 15, "yourdbtsourcet": 15, "load": 15, "dbt_seed_meta": 15, "seed_nam": 15, "your_dbt_seed_nam": 15, "yourdbtseedt": 15, "monthly_user_spend": 15, "aggreg": 15, "user_transact": 15, "user_categori": 15, "transact": 15, "usertransactionst": 15, "transaction_id": 15, "0": 15, "transaction_d": 15, "12": 15, "24": 15, "usercategoriest": 15, "categori": 15, "foo": 15, "monthlyuserspendt": 15, "month": 15, "total_spend": 15, "test_monthly_user_spend_model": 15, "transactions_data": 15, "120": 15, "10": 15, "150": 15, "20": 15, "categories_data": 15, "premium": 15, "standard": 15, "transactions_t": 15, "categories_t": 15, "expected_output": 15, "01": 15, "monthly_spend_t": 15}, "objects": {"": [[6, 0, 0, "-", "sql_mock"]], "sql_mock": [[7, 0, 0, "-", "bigquery"], [8, 0, 0, "-", "clickhouse"], [6, 0, 0, "-", "column_mocks"], [6, 0, 0, "-", "constants"], [6, 0, 0, "-", "exceptions"], [6, 0, 0, "-", "table_mocks"]], "sql_mock.bigquery": [[7, 0, 0, "-", "column_mocks"], [7, 0, 0, "-", "settings"], [7, 0, 0, "-", "table_mocks"]], "sql_mock.bigquery.column_mocks": [[7, 1, 1, "", "Array"], [7, 1, 1, "", "BigQueryColumnMock"], [7, 1, 1, "", "Date"], [7, 1, 1, "", "Decimal"], [7, 1, 1, "", "Float"], [7, 1, 1, "", "Int"], [7, 1, 1, "", "String"]], "sql_mock.bigquery.column_mocks.Array": [[7, 2, 1, "", "use_quotes_for_casting"]], "sql_mock.bigquery.column_mocks.Date": [[7, 2, 1, "", "dtype"]], "sql_mock.bigquery.column_mocks.Float": [[7, 2, 1, "", "dtype"]], "sql_mock.bigquery.column_mocks.Int": [[7, 2, 1, "", "dtype"]], "sql_mock.bigquery.column_mocks.String": [[7, 2, 1, "", "dtype"]], "sql_mock.bigquery.settings": [[7, 1, 1, "", "BigQuerySettings"]], "sql_mock.bigquery.settings.BigQuerySettings": [[7, 2, 1, "", "google_application_credentials"], [7, 2, 1, "", "model_config"], [7, 2, 1, "", "model_fields"]], "sql_mock.bigquery.table_mocks": [[7, 1, 1, "", "BigQueryMockTable"]], "sql_mock.clickhouse": [[8, 0, 0, "-", "column_mocks"], [8, 0, 0, "-", "settings"], [8, 0, 0, "-", "table_mocks"]], "sql_mock.clickhouse.column_mocks": [[8, 1, 1, "", "Array"], [8, 1, 1, "", "Boolean"], [8, 1, 1, "", "ClickhouseColumnMock"], [8, 1, 1, "", "Date"], [8, 1, 1, "", "Datetime"], [8, 1, 1, "", "Datetime64"], [8, 1, 1, "", "Decimal"], [8, 1, 1, "", "Float"], [8, 1, 1, "", "Int"], [8, 1, 1, "", "String"]], "sql_mock.clickhouse.column_mocks.Array": [[8, 2, 1, "", "use_quotes_for_casting"]], "sql_mock.clickhouse.column_mocks.Boolean": [[8, 2, 1, "", "dtype"]], "sql_mock.clickhouse.column_mocks.Date": [[8, 2, 1, "", "dtype"]], "sql_mock.clickhouse.column_mocks.Datetime": [[8, 2, 1, "", "dtype"]], "sql_mock.clickhouse.column_mocks.Datetime64": [[8, 2, 1, "", "dtype"]], "sql_mock.clickhouse.column_mocks.Float": [[8, 2, 1, "", "dtype"]], "sql_mock.clickhouse.column_mocks.Int": [[8, 2, 1, "", "dtype"]], "sql_mock.clickhouse.column_mocks.String": [[8, 2, 1, "", "dtype"]], "sql_mock.clickhouse.settings": [[8, 1, 1, "", "ClickHouseSettings"]], "sql_mock.clickhouse.settings.ClickHouseSettings": [[8, 2, 1, "", "host"], [8, 2, 1, "", "model_config"], [8, 2, 1, "", "model_fields"], [8, 2, 1, "", "password"], [8, 2, 1, "", "port"], [8, 2, 1, "", "user"]], "sql_mock.clickhouse.table_mocks": [[8, 1, 1, "", "ClickHouseTableMock"]], "sql_mock.column_mocks": [[6, 1, 1, "", "ColumnMock"]], "sql_mock.column_mocks.ColumnMock": [[6, 3, 1, "", "cast_field"], [6, 2, 1, "id0", "default"], [6, 2, 1, "id1", "dtype"], [6, 2, 1, "id2", "nullable"], [6, 3, 1, "", "to_sql"], [6, 2, 1, "id3", "use_quotes_for_casting"]], "sql_mock.constants": [[6, 1, 1, "", "NoInput"]], "sql_mock.exceptions": [[6, 4, 1, "", "ValidationError"]], "sql_mock.table_mocks": [[6, 1, 1, "", "BaseMockTable"], [6, 1, 1, "", "MockTableMeta"], [6, 1, 1, "", "SQLMockData"], [6, 6, 1, "", "table_meta"]], "sql_mock.table_mocks.BaseMockTable": [[6, 2, 1, "", "_sql_dialect"], [6, 2, 1, "", "_sql_mock_data"], [6, 3, 1, "", "as_sql_input"], [6, 3, 1, "", "assert_cte_equal"], [6, 3, 1, "", "assert_equal"], [6, 3, 1, "", "from_dicts"], [6, 3, 1, "", "from_mocks"]], "sql_mock.table_mocks.MockTableMeta": [[6, 5, 1, "", "cte_name"], [6, 2, 1, "", "default_inputs"], [6, 2, 1, "", "model_config"], [6, 2, 1, "", "model_fields"], [6, 2, 1, "id4", "query"], [6, 2, 1, "id5", "table_ref"]], "sql_mock.table_mocks.SQLMockData": [[6, 2, 1, "", "columns"], [6, 2, 1, "", "data"], [6, 2, 1, "", "input_data"], [6, 2, 1, "", "last_query"], [6, 2, 1, "", "model_config"], [6, 2, 1, "", "model_fields"], [6, 2, 1, "", "rendered_query"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:exception", "5": "py:property", "6": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "exception", "Python exception"], "5": ["py", "property", "Python property"], "6": ["py", "function", "Python function"]}, "titleterms": {"faq": 0, "my": 0, "databas": [0, 3], "system": 0, "i": [0, 16], "support": 0, "yet": 0, "want": 0, "us": [0, 15, 16, 20], "sql": [0, 3, 20], "mock": [0, 3, 15, 16, 17], "what": 0, "should": 0, "do": 0, "creat": [0, 15], "your": [0, 15, 20], "mocktabl": [0, 16], "class": 0, "columnmock": 0, "contribut": 0, "setup": [0, 1], "am": 0, "miss": 0, "specif": [0, 3], "type": 0, "model": [0, 15], "field": [0, 16], "instal": 1, "recommend": [1, 20], "pytest": 1, "quickstart": 2, "welcom": 3, "": 3, "document": 3, "get": 3, "start": 3, "basic": 3, "usag": 3, "api": 3, "refer": 3, "indic": 3, "tabl": [3, 15, 17], "sql_mock": [4, 6, 7, 8], "packag": [6, 7, 8], "subpackag": 6, "submodul": [6, 7, 8], "column_mock": [6, 7, 8], "modul": [6, 7, 8], "constant": 6, "except": 6, "table_mock": [6, 7, 8], "content": [6, 7, 8], "bigqueri": [7, 9, 10], "set": [7, 8, 11, 14, 15, 16], "clickhous": [8, 12, 13], "exampl": [9, 12, 15, 18], "test": [9, 12, 15, 20], "subscript": [9, 12], "count": [9, 12], "defin": [15, 17], "result": 19, "assert": 19, "queri": 20, "wai": 20, "provid": 20, "option": 20, "1": [15, 20], "table_meta": [16, 20], "decor": 20, "2": [15, 20], "pass": 20, "from_mock": 20, "call": 20, "jinja": 20, "templat": 20, "default": 16, "valu": 16, "util": 16, "when": 16, "thi": 16, "enhanc": [], "sqlmock": [], "dbt": 15, "integr": [], "guid": [], "introduct": 15, "prerequisit": 15, "configur": 15, "manifest": 15, "path": 15, "sourc": 15, "seed": 15, "upstream": 15, "data": 15, "step": 15, "3": 15, "write": 15, "case": 15}, "envversion": {"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": 60}, "alltitles": {"FAQ": [[0, "faq"]], "My database system is not supported yet but I want to use SQL Mock. What should I do?": [[0, "my-database-system-is-not-supported-yet-but-i-want-to-use-sql-mock-what-should-i-do"]], "Create your MockTable class": [[0, "create-your-mocktable-class"]], "Create your ColumnMocks": [[0, "create-your-columnmocks"]], "Contribute your database setup": [[0, "contribute-your-database-setup"]], "I am missing a specific ColumnMock type for my model fields": [[0, "i-am-missing-a-specific-columnmock-type-for-my-model-fields"]], "Installation": [[1, "installation"]], "Recommended Setup for Pytest": [[1, "recommended-setup-for-pytest"]], "Quickstart": [[2, "quickstart"]], "Welcome to SQL Mock\u2019s documentation!": [[3, "welcome-to-sql-mock-s-documentation"]], "Getting Started": [[3, null]], "Basic Usage": [[3, null]], "Database Specifics": [[3, null]], "API Reference": [[3, null]], "Indices and tables": [[3, "indices-and-tables"]], "sql_mock": [[4, "sql-mock"]], "sql_mock package": [[6, "sql-mock-package"]], "Subpackages": [[6, "subpackages"]], "Submodules": [[6, "submodules"], [7, "submodules"], [8, "submodules"]], "sql_mock.column_mocks module": [[6, "module-sql_mock.column_mocks"]], "sql_mock.constants module": [[6, "module-sql_mock.constants"]], "sql_mock.exceptions module": [[6, "module-sql_mock.exceptions"]], "sql_mock.table_mocks module": [[6, "module-sql_mock.table_mocks"]], "Module contents": [[6, "module-sql_mock"], [7, "module-sql_mock.bigquery"], [8, "module-sql_mock.clickhouse"]], "sql_mock.bigquery package": [[7, "sql-mock-bigquery-package"]], "sql_mock.bigquery.column_mocks module": [[7, "module-sql_mock.bigquery.column_mocks"]], "sql_mock.bigquery.settings module": [[7, "module-sql_mock.bigquery.settings"]], "sql_mock.bigquery.table_mocks module": [[7, "module-sql_mock.bigquery.table_mocks"]], "sql_mock.clickhouse package": [[8, "sql-mock-clickhouse-package"]], "sql_mock.clickhouse.column_mocks module": [[8, "module-sql_mock.clickhouse.column_mocks"]], "sql_mock.clickhouse.settings module": [[8, "module-sql_mock.clickhouse.settings"]], "sql_mock.clickhouse.table_mocks module": [[8, "module-sql_mock.clickhouse.table_mocks"]], "Example: Testing Subscription Counts in BigQuery": [[9, "example-testing-subscription-counts-in-bigquery"]], "BigQuery": [[10, "bigquery"]], "Settings": [[11, "settings"], [14, "settings"]], "Example: Testing Subscription Counts in ClickHouse": [[12, "example-testing-subscription-counts-in-clickhouse"]], "Clickhouse": [[13, "clickhouse"]], "Default values": [[16, "default-values"]], "Utilizing Default Values in MockTable Fields": [[16, "utilizing-default-values-in-mocktable-fields"]], "Setting Mock Defaults with table_meta": [[16, "setting-mock-defaults-with-table-meta"]], "When is this useful?": [[16, "when-is-this-useful"]], "Defining table mocks": [[17, "defining-table-mocks"]], "Examples": [[18, "examples"]], "Result assertion": [[19, "result-assertion"]], "Your SQL query to test": [[20, "your-sql-query-to-test"]], "Ways to provide your SQL query to be tested": [[20, "ways-to-provide-your-sql-query-to-be-tested"]], "Option 1 (recommended): Use the table_meta decorator": [[20, "option-1-recommended-use-the-table-meta-decorator"]], "Option 2: Pass the query in the .from_mocks call": [[20, "option-2-pass-the-query-in-the-from-mocks-call"]], "Queries with Jinja templates": [[20, "queries-with-jinja-templates"]], "Use with dbt": [[15, "use-with-dbt"]], "Introduction": [[15, "introduction"]], "Prerequisites": [[15, "prerequisites"]], "Configuration": [[15, "configuration"]], "Setting the dbt Manifest Path": [[15, "setting-the-dbt-manifest-path"]], "Creating Mock Tables": [[15, "creating-mock-tables"]], "dbt Model Mock Table": [[15, "dbt-model-mock-table"]], "dbt Source Mock Table": [[15, "dbt-source-mock-table"]], "dbt Seed Mock Table": [[15, "dbt-seed-mock-table"]], "Example: Testing a dbt Model with Upstream Source and Seed Data": [[15, "example-testing-a-dbt-model-with-upstream-source-and-seed-data"]], "Step 1: Define Your Source and Seed Mock Tables": [[15, "step-1-define-your-source-and-seed-mock-tables"]], "Step 2: Define Your Model Mock Table": [[15, "step-2-define-your-model-mock-table"]], "Step 3: Write Your Test Case": [[15, "step-3-write-your-test-case"]]}, "indexentries": {"module": [[3, "module-sql_mock"]], "sql_mock": [[3, "module-sql_mock"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["faq", "getting_started/installation", "getting_started/quickstart", "index", "modules", "robots", "sql_mock", "sql_mock.bigquery", "sql_mock.clickhouse", "usage/bigquery/examples", "usage/bigquery/index", "usage/bigquery/settings", "usage/clickhouse/examples", "usage/clickhouse/index", "usage/clickhouse/settings", "usage/dbt", "usage/default_values", "usage/defining_table_mocks", "usage/examples", "usage/result_assertion", "usage/your_sql_query_to_test"], "filenames": ["faq.md", "getting_started/installation.md", "getting_started/quickstart.md", "index.rst", "modules.rst", "robots.txt", "sql_mock.rst", "sql_mock.bigquery.rst", "sql_mock.clickhouse.rst", "usage/bigquery/examples.md", "usage/bigquery/index.rst", "usage/bigquery/settings.md", "usage/clickhouse/examples.md", "usage/clickhouse/index.rst", "usage/clickhouse/settings.md", "usage/dbt.md", "usage/default_values.md", "usage/defining_table_mocks.md", "usage/examples.md", "usage/result_assertion.md", "usage/your_sql_query_to_test.md"], "titles": ["FAQ", "Installation", "Quickstart", "Welcome to SQL Mock\u2019s documentation!", "sql_mock", "<no title>", "sql_mock package", "sql_mock.bigquery package", "sql_mock.clickhouse package", "Example: Testing Subscription Counts in BigQuery", "BigQuery", "Settings", "Example: Testing Subscription Counts in ClickHouse", "Clickhouse", "Settings", "Use with dbt", "Default values", "Defining table mocks", "Examples", "Result assertion", "Your SQL query to test"], "terms": {"we": [0, 1, 2, 6, 15, 16, 17, 19, 20], "ar": [0, 1, 6, 15, 16, 17, 19, 20], "plan": 0, "add": [0, 1, 6], "more": [0, 2, 17, 19], "howev": 0, "you": [0, 1, 2, 6, 11, 14, 15, 16, 17, 18, 19, 20], "can": [0, 1, 2, 6, 15, 16, 17, 18, 19, 20], "still": 0, "There": [0, 17, 19, 20], "onli": [0, 6, 16, 17, 19, 20], "2": [0, 2, 3, 9, 12, 16, 17, 19], "thing": [0, 17], "need": [0, 1, 3, 6, 11, 14, 16, 17, 20], "first": 0, "inherit": [0, 6, 9, 12, 17], "from": [0, 1, 2, 6, 7, 8, 9, 12, 15, 17, 19, 20], "sql_mock": [0, 1, 2, 9, 12, 15, 17, 19], "table_mock": [0, 2, 9, 12, 15, 17, 19], "basemockt": [0, 6, 7, 8, 17], "That": 0, "implement": [0, 16], "_get_result": 0, "method": [0, 1, 2, 16, 17, 19, 20], "which": [0, 6, 15], "make": [0, 1, 15], "sure": [0, 1, 15], "fetch": 0, "result": [0, 2, 3, 6, 9, 12, 15, 17], "queri": [0, 2, 3, 6, 9, 12, 16, 17, 19], "e": [0, 2, 6, 17, 20], "g": [0, 2, 6, 17, 20], "produc": [0, 15], "self": 0, "_generate_queri": 0, "return": [0, 6], "list": [0, 6], "dictionari": [0, 2, 6, 7, 8, 20], "look": 0, "one": [0, 6, 16], "exist": 0, "client": 0, "librari": [0, 1, 3, 15], "see": 0, "how": [0, 2, 10, 13, 15, 16, 17, 19, 20], "thi": [0, 1, 2, 3, 6, 7, 8, 10, 13, 15, 17, 19, 20], "could": 0, "work": [0, 2, 15, 16], "bigquerymockt": [0, 2, 6, 7, 9, 15, 16, 17, 19], "might": 0, "set": [0, 3, 6, 10, 13], "well": [0, 17], "case": [0, 3, 16, 19, 20], "some": [0, 2, 17, 18, 20], "connect": [0, 11, 14], "avail": [0, 2], "within": [0, 6], "In": [0, 1, 2, 11, 14, 16, 19, 20], "order": [0, 6, 11, 14], "them": [0, 17, 20], "column": [0, 2, 6, 15, 16], "column_mock": [0, 2, 9, 12, 17, 19], "base": [0, 2, 6, 7, 8], "For": [0, 15, 16], "most": 0, "specifi": [0, 2, 16, 17, 20], "dtype": [0, 6, 7, 8], "pars": 0, "input": [0, 2, 3, 6, 15, 16, 17, 19, 20], "A": [0, 6, 15, 19], "good": 0, "practis": 0, "all": [0, 1, 2, 6, 16, 17], "import": [0, 1, 2, 9, 12, 15, 17, 19], "myfancedatabasecolumnmock": 0, "logic": [0, 16, 19], "overwrit": [0, 6, 17], "default": [0, 2, 3, 6, 7, 8, 9, 12, 15, 17, 19, 20], "behavior": 0, "so": 0, "here": [0, 15, 16], "pass": [0, 3, 16, 17], "int": [0, 2, 6, 7, 8, 9, 12, 15, 16, 17, 19, 20], "integ": [0, 7, 8], "string": [0, 2, 6, 7, 8, 9, 12, 15, 16, 17, 19, 20], "definit": [0, 16, 17], "folk": 0, "commun": 0, "just": 0, "feel": 0, "free": 0, "pr": 0, "repositori": 0, "start": [0, 2, 15], "implementd": 0, "basic": [0, 16], "happen": [0, 6], "don": [0, 2, 16], "t": [0, 2, 9, 12, 16, 19], "find": [0, 18], "luckili": 0, "easili": [0, 17], "those": [0, 14, 17, 19, 20], "tool": [0, 15], "provid": [0, 2, 3, 6, 14, 15, 16, 17], "The": [0, 1, 3, 6, 15, 16, 17, 20], "bigquerycolumnmock": [0, 6, 7], "write": [0, 3], "usual": [0, 17], "correct": [0, 16], "would": [0, 6], "later": 0, "cast": [0, 2, 6], "col": [0, 2, 9, 12, 15, 16, 17, 19, 20], "express": [0, 2], "replac": [0, 2, 6, 7, 8], "bigqueri": [0, 1, 3, 6, 11, 15, 17, 19], "myfancymissingcoltyp": 0, "fancymissingcoltyp": 0, "addit": [0, 16], "forget": 0, "pypi": 1, "us": [1, 2, 3, 6, 9, 10, 11, 12, 13, 14, 17, 19], "pip": 1, "upgrad": 1, "sql": [1, 2, 5, 6, 9, 10, 11, 12, 13, 14, 16, 17, 19], "mock": [1, 2, 5, 6, 9, 10, 11, 12, 13, 14, 19, 20], "clickhous": [1, 2, 3, 6, 14], "If": [1, 6], "modifi": 1, "sourc": [1, 3], "code": [1, 16], "depend": 1, "poetri": 1, "extra": [1, 7, 8], "conftest": 1, "py": [1, 17, 20], "file": [1, 6, 11, 15, 17, 20], "root": 1, "your": [1, 2, 3, 9, 12, 14, 16, 17, 19], "project": [1, 15], "follow": [1, 14, 19, 20], "line": 1, "register_assert_rewrit": 1, "allow": [1, 3, 16, 17], "get": [1, 2], "rich": 1, "comparison": [1, 6], "when": [1, 3, 6, 14, 17, 19, 20], "assert_equ": [1, 2, 6, 9, 12, 15, 19], "tabl": [1, 2, 6, 9, 12, 16, 19, 20], "instanc": [1, 2, 6, 14, 16, 17, 19, 20], "also": [1, 17, 19, 20], "icdiff": 1, "better": 1, "visibl": 1, "diff": 1, "fail": [1, 6], "test": [1, 3, 6, 10, 11, 13, 14, 16, 17, 19], "befor": 2, "dive": 2, "specif": [2, 10, 13, 16, 20], "databas": [2, 6, 15, 17], "scenario": [2, 3, 16], "let": [2, 11, 15, 16, 19, 20], "": [2, 6, 15, 16, 19, 20], "simplifi": [2, 3, 16], "exampl": [2, 3, 10, 13, 16, 19, 20], "behind": 2, "scene": 2, "have": [2, 11, 14, 17, 19], "an": [2, 16], "origin": [2, 6, 9, 12], "path": [2, 3, 6, 7, 8, 16, 17, 20], "query_for_result_t": [2, 17, 20], "select": [2, 9, 12, 17, 19, 20], "id": [2, 17, 20], "data": [2, 3, 6, 9, 12, 16, 17, 19, 20], "table1": [2, 17], "defin": [2, 3, 6, 7, 8, 9, 12, 16, 19, 20], "built": [2, 19], "type": [2, 3, 6], "includ": [2, 19], "date": [2, 6, 7, 8, 9, 12, 15, 19], "each": 2, "ha": [2, 15], "own": 2, "subclass": 2, "class": [2, 3, 6, 7, 8, 9, 12, 15, 16, 17, 19, 20], "fit": 2, "along": 2, "valu": [2, 3, 6], "our": [2, 19], "clickhousetablemock": [2, 6, 8, 12], "table_meta": [2, 3, 6, 9, 12, 17, 19], "table_ref": [2, 6, 9, 12, 16, 17, 19, 20], "1": [2, 3, 6, 9, 12, 16, 17, 19], "name": [2, 6, 7, 8, 15, 17], "peter": [2, 17], "result_t": [2, 17, 20], "query_path": [2, 6, 16, 17, 19, 20], "resultt": [2, 17, 20], "creat": [2, 3, 6, 9, 12, 16, 17], "repres": [2, 6], "row": [2, 6], "kei": [2, 6], "correspond": 2, "user_data": 2, "both": 2, "martin": 2, "3": [2, 3, 16], "input_table_mock": 2, "from_dict": [2, 6, 9, 12, 15, 16, 19], "from_mock": [2, 3, 6, 9, 12, 15, 16, 17, 19], "object": [2, 6], "gener": [2, 6], "re": [2, 9, 12, 16, 17, 19, 20], "input_data": [2, 6, 9, 12, 15, 16, 17, 19, 20], "refer": [2, 6], "common": 2, "cte": [2, 6, 19], "fill": [2, 16], "dummi": 2, "It": [2, 3, 6], "roughli": 2, "compar": [2, 6], "someth": 2, "like": [2, 6, 17], "WITH": [2, 19], "data__table1": 2, "AS": [2, 9, 12, 19, 20], "union": [2, 6], "final": [2, 6, 19], "expect": [2, 6, 9, 12, 15], "primari": 3, "purpos": 3, "i": [3, 6, 15, 17, 20], "model": [3, 6, 7, 8, 9, 12, 17, 19, 20], "user": [3, 5, 6, 8, 9, 12, 14, 16, 19, 20], "variou": [3, 16], "consist": [3, 16], "conveni": 3, "wai": [3, 16, 17, 19], "execut": 3, "without": 3, "process": [3, 6, 16], "massiv": 3, "amount": [3, 15], "instal": [3, 15], "recommend": [3, 17], "setup": [3, 16], "pytest": 3, "quickstart": 3, "faq": 3, "my": 3, "system": 3, "support": 3, "yet": 3, "want": [3, 6, 14, 17, 19, 20], "what": 3, "should": [3, 6, 7, 8], "do": [3, 19], "mocktabl": [3, 6, 17], "columnmock": [3, 6, 7, 8], "contribut": 3, "am": 3, "miss": 3, "field": [3, 6, 7, 8], "option": 3, "decor": [3, 6, 15, 16, 17], "call": 3, "jinja": [3, 6], "templat": [3, 6], "assert": [3, 6, 9, 12], "subscript": [3, 10, 13, 16, 19], "count": [3, 10, 13, 19], "index": 3, "modul": 3, "search": 3, "page": 3, "agent": 5, "sitemap": 5, "http": 5, "deeplcom": 5, "github": 5, "io": 5, "xml": 5, "decim": [6, 7, 8], "float": [6, 7, 8, 15], "bigqueryset": [6, 7], "google_application_credenti": [6, 7, 11], "model_config": [6, 7, 8], "model_field": [6, 7, 8], "boolean": [6, 8], "clickhousecolumnmock": [6, 8], "datetim": [6, 8, 9, 12, 15, 19], "datetime64": [6, 8], "clickhouseset": [6, 8], "host": [6, 8, 14], "password": [6, 8, 14], "port": [6, 8, 14], "none": [6, 7, 8], "nullabl": [6, 7, 8], "fals": [6, 7, 8], "str": [6, 7, 8], "indic": 6, "whether": 6, "null": 6, "cast_field": 6, "column_nam": 6, "to_sql": 6, "noinput": 6, "validationerror": 6, "dict": [6, 7, 8], "attribut": [6, 15], "col1": 6, "_sql_mock_data": 6, "store": 6, "automatci": 6, "instanti": 6, "sqlmockdata": 6, "_sql_mock_meta": 6, "metadata": [6, 7, 8], "mocktablemeta": 6, "as_sql_input": 6, "combin": [6, 16], "assert_cte_equ": [6, 19], "cte_nam": 6, "ignore_missing_kei": 6, "bool": [6, 7, 8], "ignore_ord": 6, "true": [6, 7, 8], "equal": 6, "paramet": 6, "against": 6, "present": 6, "argument": [6, 16, 17, 20], "ignor": 6, "classmethod": 6, "query_template_kwarg": [6, 20], "run": [6, 11, 14, 15, 19], "static": [6, 15], "hold": 6, "pair": 6, "render": [6, 20], "cl": 6, "basemodel": 6, "dure": 6, "avoid": 6, "collis": 6, "srting": 6, "format": 6, "classvar": [6, 7, 8], "configdict": [6, 7, 8], "configur": [3, 6, 7, 8], "conform": [6, 7, 8], "pydant": [6, 7, 8], "config": [6, 7, 8, 15], "fieldinfo": [6, 7, 8], "annot": [6, 7, 8], "requir": [6, 7, 8, 16], "about": [6, 7, 8], "map": [6, 7, 8, 19], "__fields__": [6, 7, 8], "v1": [6, 7, 8], "rendered_queri": 6, "last_queri": 6, "get_keys_from_list_of_dict": [], "replace_original_table_refer": [], "mock_tabl": [], "orign": [], "point": 11, "select_from_ct": [], "statement": [], "select_ct": [], "note": [6, 20], "validate_input_mock": [], "precis": [7, 8], "scale": [7, 8], "_case_sensit": [7, 8], "_env_prefix": [7, 8], "_env_fil": [7, 8], "dotenvtyp": [7, 8], "posixpath": [7, 8], "_env_file_encod": [7, 8], "_env_nested_delimit": [7, 8], "_secrets_dir": [7, 8], "baseset": [7, 8], "settingsconfigdict": [7, 8], "arbitrary_types_allow": [6, 7, 8], "case_sensit": [7, 8], "env_fil": [7, 8], "env_file_encod": [7, 8], "env_nested_delimit": [7, 8], "env_prefix": [7, 8], "forbid": [7, 8], "protected_namespac": [7, 8], "model_": [7, 8], "settings_": [7, 8], "secrets_dir": [7, 8], "validate_default": [7, 8], "arg": [7, 8], "kwarg": [7, 8], "sql_mock_clickhouse_": 8, "usert": [9, 12, 16, 19], "user_id": [9, 12, 15, 16, 19, 20], "user_nam": [9, 12, 16, 19], "mr": [9, 12, 16, 19], "subscriptiont": [9, 12, 16, 19], "subscription_id": [9, 12, 16, 19], "period_start_d": [9, 12, 19], "2023": [9, 12, 15, 19, 20], "9": [9, 12, 19], "5": [9, 12, 19], "period_end_d": [9, 12, 19], "subscriptioncountt": [9, 12], "subscription_count": [9, 12, 19], "left": [9, 12, 16, 19], "join": [9, 12, 16, 19], "group": [9, 12, 19], "BY": [9, 12, 19], "simul": [9, 12], "section": [10, 13, 17], "document": [10, 13], "ensur": [11, 16], "environ": [11, 14, 15], "variabl": [11, 14, 20], "correctli": [11, 16], "servic": 11, "account": 11, "while": 11, "sql_mock_clickhouse_host": 14, "sql_mock_clickhouse_us": 14, "sql_mock_clickhouse_password": 14, "sql_mock_clickhouse_port": 14, "enabl": 14, "upstream": [3, 17], "central": 17, "where": [17, 19, 20], "reus": [17, 20], "across": [16, 17], "goign": 17, "mention": 17, "referenc": 17, "product": 17, "pattern": 17, "schema": 17, "current": 17, "u": 17, "onc": [17, 20], "whatev": [17, 20], "wa": [17, 20], "read": 17, "detail": 17, "handl": 17, "found": 17, "folder": 18, "check": 19, "output": [6, 19], "given": [19, 20], "normal": 19, "full": 19, "lot": 19, "time": [16, 19], "complic": 19, "thei": [16, 19], "bunch": 19, "separ": 19, "step": [3, 16, 19], "unit": [15, 19], "abl": 19, "singl": [16, 19], "To": 19, "assum": [19, 20], "subscriptions_per_us": 19, "sub": 19, "ON": 19, "users_with_multiple_sub": 19, "test_queri": [16, 19], "multiplesubscriptionuserst": [16, 19], "now": 19, "differ": [15, 16, 19], "def": [15, 19], "test_model": 19, "subscriptions_per_user__expect": 19, "users_with_multiple_subs__expect": 19, "end_result__expect": 19, "end": 19, "multipl": [16, 20], "walk": 20, "through": 20, "cover": [15, 20], "bigquerytablemock": 20, "itself": 20, "advantag": 20, "after": 20, "mani": 20, "overwrid": 20, "sometim": 20, "dbt": [3, 20], "necessari": [15, 20], "context": 20, "created_at": 20, "creation_d": 20, "your_input_mock_inst": 20, "09": 20, "05": 20, "automat": 20, "_sql_dialect": 6, "dialect": 6, "leverag": 6, "sqlglot": 6, "sql_dialect": [], "sql_mock_data": 6, "default_input": [6, 16, 17], "serv": 6, "other": [6, 15, 16], "often": 16, "involv": 16, "repetit": 16, "sqlmock": [15, 16], "effect": [15, 16], "streamlin": 16, "By": 16, "reason": 16, "significantli": 16, "reduc": 16, "boilerpl": 16, "especi": 16, "deal": 16, "complex": 16, "explor": 16, "effici": 16, "level": [16, 17], "straightforward": 16, "particularli": 16, "function": 16, "oper": 16, "overrid": 16, "nala": 16, "No": 16, "accept": 16, "consid": [15, 16], "up": 16, "demonstr": 16, "happi": 16, "valid": 16, "syntax": 16, "minim": 16, "subset": 16, "certain": 16, "help": 16, "focu": 16, "numer": 16, "between": 16, "frequent": 16, "new": 16, "prevent": 16, "extens": 16, "refactor": 16, "ani": [], "skipvalid": 6, "empti": 16, "util": 3, "safe": 16, "chang": 16, "rest": 16, "stringarrai": [], "properti": 6, "arrai": [6, 7, 8], "constant": [], "use_quotes_for_cast": [6, 7, 8], "quot": 6, "inner_dtyp": [7, 8], "print_query_on_fail": 6, "print": 6, "consol": 6, "enhanc": [], "integr": [], "guid": 15, "introduct": 3, "prerequisit": 3, "manifest": 3, "seed": 3, "quick": 15, "build": 15, "ll": 15, "featur": 15, "json": 15, "latest": 15, "compil": 15, "python": 15, "initi": 15, "global": 15, "sqlmockconfig": 15, "set_dbt_manifest_path": 15, "offer": 15, "special": 15, "entiti": 15, "dbt_model_meta": 15, "suit": 15, "transform": 15, "model_nam": 15, "your_dbt_model_nam": 15, "yourdbtmodelt": 15, "dbt_source_meta": 15, "ideal": 15, "raw": 15, "consum": 15, "source_nam": 15, "your_source_nam": 15, "table_nam": 15, "your_source_t": 15, "yourdbtsourcet": 15, "load": 15, "dbt_seed_meta": 15, "seed_nam": 15, "your_dbt_seed_nam": 15, "yourdbtseedt": 15, "monthly_user_spend": 15, "aggreg": 15, "user_transact": 15, "user_categori": 15, "transact": 15, "usertransactionst": 15, "transaction_id": 15, "0": 15, "transaction_d": 15, "12": 15, "24": 15, "usercategoriest": 15, "categori": 15, "foo": 15, "monthlyuserspendt": 15, "month": 15, "total_spend": 15, "test_monthly_user_spend_model": 15, "transactions_data": 15, "120": 15, "10": 15, "150": 15, "20": 15, "categories_data": 15, "premium": 15, "standard": 15, "transactions_t": 15, "categories_t": 15, "expected_output": 15, "01": 15, "monthly_spend_t": 15}, "objects": {"": [[3, 0, 0, "-", "sql_mock"]], "sql_mock": [[7, 0, 0, "-", "bigquery"], [8, 0, 0, "-", "clickhouse"], [6, 0, 0, "-", "column_mocks"], [6, 0, 0, "-", "constants"], [6, 0, 0, "-", "exceptions"], [6, 0, 0, "-", "table_mocks"]], "sql_mock.bigquery": [[7, 0, 0, "-", "column_mocks"], [7, 0, 0, "-", "settings"], [7, 0, 0, "-", "table_mocks"]], "sql_mock.bigquery.column_mocks": [[7, 1, 1, "", "Array"], [7, 1, 1, "", "BigQueryColumnMock"], [7, 1, 1, "", "Date"], [7, 1, 1, "", "Decimal"], [7, 1, 1, "", "Float"], [7, 1, 1, "", "Int"], [7, 1, 1, "", "String"]], "sql_mock.bigquery.column_mocks.Array": [[7, 2, 1, "", "use_quotes_for_casting"]], "sql_mock.bigquery.column_mocks.Date": [[7, 2, 1, "", "dtype"]], "sql_mock.bigquery.column_mocks.Float": [[7, 2, 1, "", "dtype"]], "sql_mock.bigquery.column_mocks.Int": [[7, 2, 1, "", "dtype"]], "sql_mock.bigquery.column_mocks.String": [[7, 2, 1, "", "dtype"]], "sql_mock.bigquery.settings": [[7, 1, 1, "", "BigQuerySettings"]], "sql_mock.bigquery.settings.BigQuerySettings": [[7, 2, 1, "", "google_application_credentials"], [7, 2, 1, "", "model_config"], [7, 2, 1, "", "model_fields"]], "sql_mock.bigquery.table_mocks": [[7, 1, 1, "", "BigQueryMockTable"]], "sql_mock.clickhouse": [[8, 0, 0, "-", "column_mocks"], [8, 0, 0, "-", "settings"], [8, 0, 0, "-", "table_mocks"]], "sql_mock.clickhouse.column_mocks": [[8, 1, 1, "", "Array"], [8, 1, 1, "", "Boolean"], [8, 1, 1, "", "ClickhouseColumnMock"], [8, 1, 1, "", "Date"], [8, 1, 1, "", "Datetime"], [8, 1, 1, "", "Datetime64"], [8, 1, 1, "", "Decimal"], [8, 1, 1, "", "Float"], [8, 1, 1, "", "Int"], [8, 1, 1, "", "String"]], "sql_mock.clickhouse.column_mocks.Array": [[8, 2, 1, "", "use_quotes_for_casting"]], "sql_mock.clickhouse.column_mocks.Boolean": [[8, 2, 1, "", "dtype"]], "sql_mock.clickhouse.column_mocks.Date": [[8, 2, 1, "", "dtype"]], "sql_mock.clickhouse.column_mocks.Datetime": [[8, 2, 1, "", "dtype"]], "sql_mock.clickhouse.column_mocks.Datetime64": [[8, 2, 1, "", "dtype"]], "sql_mock.clickhouse.column_mocks.Float": [[8, 2, 1, "", "dtype"]], "sql_mock.clickhouse.column_mocks.Int": [[8, 2, 1, "", "dtype"]], "sql_mock.clickhouse.column_mocks.String": [[8, 2, 1, "", "dtype"]], "sql_mock.clickhouse.settings": [[8, 1, 1, "", "ClickHouseSettings"]], "sql_mock.clickhouse.settings.ClickHouseSettings": [[8, 2, 1, "", "host"], [8, 2, 1, "", "model_config"], [8, 2, 1, "", "model_fields"], [8, 2, 1, "", "password"], [8, 2, 1, "", "port"], [8, 2, 1, "", "user"]], "sql_mock.clickhouse.table_mocks": [[8, 1, 1, "", "ClickHouseTableMock"]], "sql_mock.column_mocks": [[6, 1, 1, "", "ColumnMock"]], "sql_mock.column_mocks.ColumnMock": [[6, 3, 1, "", "cast_field"], [6, 2, 1, "id0", "default"], [6, 2, 1, "id1", "dtype"], [6, 2, 1, "id2", "nullable"], [6, 3, 1, "", "to_sql"], [6, 2, 1, "id3", "use_quotes_for_casting"]], "sql_mock.constants": [[6, 1, 1, "", "NoInput"]], "sql_mock.exceptions": [[6, 4, 1, "", "ValidationError"]], "sql_mock.table_mocks": [[6, 1, 1, "", "BaseMockTable"], [6, 1, 1, "", "MockTableMeta"], [6, 1, 1, "", "SQLMockData"], [6, 6, 1, "", "table_meta"]], "sql_mock.table_mocks.BaseMockTable": [[6, 2, 1, "", "_sql_dialect"], [6, 2, 1, "", "_sql_mock_data"], [6, 3, 1, "", "as_sql_input"], [6, 3, 1, "", "assert_cte_equal"], [6, 3, 1, "", "assert_equal"], [6, 3, 1, "", "from_dicts"], [6, 3, 1, "", "from_mocks"]], "sql_mock.table_mocks.MockTableMeta": [[6, 5, 1, "", "cte_name"], [6, 2, 1, "", "default_inputs"], [6, 2, 1, "", "model_config"], [6, 2, 1, "", "model_fields"], [6, 2, 1, "id4", "query"], [6, 2, 1, "id5", "table_ref"]], "sql_mock.table_mocks.SQLMockData": [[6, 2, 1, "", "columns"], [6, 2, 1, "", "data"], [6, 2, 1, "", "input_data"], [6, 2, 1, "", "last_query"], [6, 2, 1, "", "model_config"], [6, 2, 1, "", "model_fields"], [6, 2, 1, "", "rendered_query"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:exception", "5": "py:property", "6": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "exception", "Python exception"], "5": ["py", "property", "Python property"], "6": ["py", "function", "Python function"]}, "titleterms": {"faq": 0, "my": 0, "databas": [0, 3], "system": 0, "i": [0, 16], "support": 0, "yet": 0, "want": 0, "us": [0, 15, 16, 20], "sql": [0, 3, 20], "mock": [0, 3, 15, 16, 17], "what": 0, "should": 0, "do": 0, "creat": [0, 15], "your": [0, 15, 20], "mocktabl": [0, 16], "class": 0, "columnmock": 0, "contribut": 0, "setup": [0, 1], "am": 0, "miss": 0, "specif": [0, 3], "type": 0, "model": [0, 15], "field": [0, 16], "instal": 1, "recommend": [1, 20], "pytest": 1, "quickstart": 2, "welcom": 3, "": 3, "document": 3, "get": 3, "start": 3, "basic": 3, "usag": 3, "api": 3, "refer": 3, "indic": 3, "tabl": [3, 15, 17], "sql_mock": [4, 6, 7, 8], "packag": [6, 7, 8], "subpackag": 6, "submodul": [6, 7, 8], "column_mock": [6, 7, 8], "modul": [6, 7, 8], "constant": 6, "except": 6, "table_mock": [6, 7, 8], "content": [6, 7, 8], "bigqueri": [7, 9, 10], "set": [7, 8, 11, 14, 15, 16], "clickhous": [8, 12, 13], "exampl": [9, 12, 15, 18], "test": [9, 12, 15, 20], "subscript": [9, 12], "count": [9, 12], "defin": [15, 17], "result": 19, "assert": 19, "queri": 20, "wai": 20, "provid": 20, "option": 20, "1": [15, 20], "table_meta": [16, 20], "decor": 20, "2": [15, 20], "pass": 20, "from_mock": 20, "call": 20, "jinja": 20, "templat": 20, "default": 16, "valu": 16, "util": 16, "when": 16, "thi": 16, "enhanc": [], "sqlmock": [], "dbt": 15, "integr": [], "guid": [], "introduct": 15, "prerequisit": 15, "configur": 15, "manifest": 15, "path": 15, "sourc": 15, "seed": 15, "upstream": 15, "data": 15, "step": 15, "3": 15, "write": 15, "case": 15}, "envversion": {"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": 60}, "alltitles": {"FAQ": [[0, "faq"]], "My database system is not supported yet but I want to use SQL Mock. What should I do?": [[0, "my-database-system-is-not-supported-yet-but-i-want-to-use-sql-mock-what-should-i-do"]], "Create your MockTable class": [[0, "create-your-mocktable-class"]], "Create your ColumnMocks": [[0, "create-your-columnmocks"]], "Contribute your database setup": [[0, "contribute-your-database-setup"]], "I am missing a specific ColumnMock type for my model fields": [[0, "i-am-missing-a-specific-columnmock-type-for-my-model-fields"]], "Installation": [[1, "installation"]], "Recommended Setup for Pytest": [[1, "recommended-setup-for-pytest"]], "Quickstart": [[2, "quickstart"]], "sql_mock": [[4, "sql-mock"]], "sql_mock package": [[6, "sql-mock-package"]], "Subpackages": [[6, "subpackages"]], "Submodules": [[6, "submodules"], [7, "submodules"], [8, "submodules"]], "sql_mock.column_mocks module": [[6, "module-sql_mock.column_mocks"]], "sql_mock.constants module": [[6, "module-sql_mock.constants"]], "sql_mock.exceptions module": [[6, "module-sql_mock.exceptions"]], "sql_mock.table_mocks module": [[6, "module-sql_mock.table_mocks"]], "Module contents": [[6, "module-sql_mock"], [7, "module-sql_mock.bigquery"], [8, "module-sql_mock.clickhouse"]], "sql_mock.bigquery package": [[7, "sql-mock-bigquery-package"]], "sql_mock.bigquery.column_mocks module": [[7, "module-sql_mock.bigquery.column_mocks"]], "sql_mock.bigquery.settings module": [[7, "module-sql_mock.bigquery.settings"]], "sql_mock.bigquery.table_mocks module": [[7, "module-sql_mock.bigquery.table_mocks"]], "sql_mock.clickhouse package": [[8, "sql-mock-clickhouse-package"]], "sql_mock.clickhouse.column_mocks module": [[8, "module-sql_mock.clickhouse.column_mocks"]], "sql_mock.clickhouse.settings module": [[8, "module-sql_mock.clickhouse.settings"]], "sql_mock.clickhouse.table_mocks module": [[8, "module-sql_mock.clickhouse.table_mocks"]], "Example: Testing Subscription Counts in BigQuery": [[9, "example-testing-subscription-counts-in-bigquery"]], "BigQuery": [[10, "bigquery"]], "Settings": [[11, "settings"], [14, "settings"]], "Example: Testing Subscription Counts in ClickHouse": [[12, "example-testing-subscription-counts-in-clickhouse"]], "Clickhouse": [[13, "clickhouse"]], "Default values": [[16, "default-values"]], "Utilizing Default Values in MockTable Fields": [[16, "utilizing-default-values-in-mocktable-fields"]], "Setting Mock Defaults with table_meta": [[16, "setting-mock-defaults-with-table-meta"]], "When is this useful?": [[16, "when-is-this-useful"]], "Defining table mocks": [[17, "defining-table-mocks"]], "Examples": [[18, "examples"]], "Result assertion": [[19, "result-assertion"]], "Your SQL query to test": [[20, "your-sql-query-to-test"]], "Ways to provide your SQL query to be tested": [[20, "ways-to-provide-your-sql-query-to-be-tested"]], "Option 1 (recommended): Use the table_meta decorator": [[20, "option-1-recommended-use-the-table-meta-decorator"]], "Option 2: Pass the query in the .from_mocks call": [[20, "option-2-pass-the-query-in-the-from-mocks-call"]], "Queries with Jinja templates": [[20, "queries-with-jinja-templates"]], "Use with dbt": [[15, "use-with-dbt"]], "Introduction": [[15, "introduction"]], "Prerequisites": [[15, "prerequisites"]], "Configuration": [[15, "configuration"]], "Setting the dbt Manifest Path": [[15, "setting-the-dbt-manifest-path"]], "Creating Mock Tables": [[15, "creating-mock-tables"]], "dbt Model Mock Table": [[15, "dbt-model-mock-table"]], "dbt Source Mock Table": [[15, "dbt-source-mock-table"]], "dbt Seed Mock Table": [[15, "dbt-seed-mock-table"]], "Example: Testing a dbt Model with Upstream Source and Seed Data": [[15, "example-testing-a-dbt-model-with-upstream-source-and-seed-data"]], "Step 1: Define Your Source and Seed Mock Tables": [[15, "step-1-define-your-source-and-seed-mock-tables"]], "Step 2: Define Your Model Mock Table": [[15, "step-2-define-your-model-mock-table"]], "Step 3: Write Your Test Case": [[15, "step-3-write-your-test-case"]], "Welcome to SQL Mock\u2019s documentation!": [[3, "welcome-to-sql-mock-s-documentation"]], "Getting Started": [[3, null]], "Basic Usage": [[3, null]], "Database Specifics": [[3, null]], "API Reference": [[3, null]], "Indices and tables": [[3, "indices-and-tables"]]}, "indexentries": {"module": [[3, "module-sql_mock"]], "sql_mock": [[3, "module-sql_mock"]]}}) \ No newline at end of file diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 5b61479..a6b6963 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -1,2 +1,2 @@ -https://deeplcom.github.io/sql-mock/en/index.htmlhttps://deeplcom.github.io/sql-mock/en/usage/dbt.htmlhttps://deeplcom.github.io/sql-mock/en/genindex.htmlhttps://deeplcom.github.io/sql-mock/en/py-modindex.htmlhttps://deeplcom.github.io/sql-mock/en/search.html \ No newline at end of file +https://deeplcom.github.io/sql-mock/en/index.htmlhttps://deeplcom.github.io/sql-mock/en/genindex.htmlhttps://deeplcom.github.io/sql-mock/en/py-modindex.htmlhttps://deeplcom.github.io/sql-mock/en/search.html \ No newline at end of file