blob: 271e48b04927f4e4f4d893abc25666d90b692eca [file] [log] [blame]
Search.setIndex({"docnames": ["_api/airflow/providers/mongo/hooks/index", "_api/airflow/providers/mongo/hooks/mongo/index", "_api/airflow/providers/mongo/index", "_api/airflow/providers/mongo/sensors/index", "_api/airflow/providers/mongo/sensors/mongo/index", "commits", "connections/mongo", "index", "installing-providers-from-sources"], "filenames": ["_api/airflow/providers/mongo/hooks/index.rst", "_api/airflow/providers/mongo/hooks/mongo/index.rst", "_api/airflow/providers/mongo/index.rst", "_api/airflow/providers/mongo/sensors/index.rst", "_api/airflow/providers/mongo/sensors/mongo/index.rst", "commits.rst", "connections/mongo.rst", "index.rst", "installing-providers-from-sources.rst"], "titles": ["<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.mongo.hooks</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.mongo.hooks.mongo</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.mongo</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.mongo.sensors</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.mongo.sensors.mongo</span></code>", "Package apache-airflow-providers-mongo", "MongoDB Connection", "<code class=\"docutils literal notranslate\"><span class=\"pre\">apache-airflow-providers-mongo</span></code>", "Installing from sources"], "terms": {"3": [0, 1, 2, 3, 4, 6, 8], "0": [0, 1, 2, 3, 4, 6, 8], "2": [0, 1, 2, 3, 4, 6, 8], "4": [0, 1, 2, 3, 4, 5, 6, 7, 8], "dev0": [0, 1, 2, 3, 4, 5, 6, 7, 8], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8], "i": [0, 1, 2, 3, 4, 5, 6, 7, 8], "an": [0, 1, 2, 3, 4, 5, 6, 7, 8], "experiment": [0, 1, 2, 3, 4, 5, 6, 7, 8], "featur": [0, 1, 2, 3, 4, 5, 6, 8], "db": [1, 7], "mongohook": 1, "conn_id": 1, "default_conn_nam": 1, "arg": [1, 5], "kwarg": [1, 4], "sourc": [1, 4, 7], "base": [1, 4], "basehook": 1, "interact": 1, "us": [1, 4, 5, 6, 8], "pymongo": [1, 7], "wrapper": 1, "With": 1, "databas": [1, 6], "connect": [1, 4, 5, 7], "document": [1, 4, 5, 7], "http": [1, 7, 8], "doc": [1, 5, 7], "mongodb": [1, 4, 5, 7], "com": [1, 6, 7, 8], "manual": [1, 7], "refer": 1, "string": [1, 5, 6, 7], "index": 1, "html": 1, "you": [1, 6, 7, 8], "can": [1, 6, 7, 8], "specifi": [1, 6], "option": [1, 6], "extra": [1, 6], "field": [1, 5], "your": [1, 7], "If": [1, 7, 8], "want": [1, 7, 8], "dn": [1, 6], "seedlist": 1, "set": 1, "srv": [1, 6], "true": 1, "ex": 1, "replicaset": 1, "test": 1, "ssl": [1, 6], "connecttimeoutm": 1, "30000": 1, "paramet": [1, 4, 6], "mongo_conn_id": [1, 4], "The": [1, 4, 6, 8], "id": [1, 4, 8], "when": [1, 4, 6], "conn_name_attr": 1, "mongo_default": [1, 4, 6], "conn_typ": 1, "hook_nam": 1, "__enter__": 1, "__exit__": 1, "exc_typ": 1, "exc_val": 1, "exc_tb": 1, "get_conn": 1, "fetch": 1, "client": [1, 6], "close_conn": 1, "close": 1, "get_collect": 1, "mongo_collect": 1, "mongo_db": [1, 4, 5, 7], "none": [1, 4, 8], "collect": [1, 4], "object": [1, 6], "queri": [1, 4], "schema": [1, 6], "unless": 1, "aggreg": 1, "aggregate_queri": 1, "run": [1, 7, 8], "pipelin": 1, "return": 1, "result": 1, "readthedoc": 1, "io": 1, "en": 1, "stabl": 1, "api": [1, 7], "exampl": [1, 4, 6, 8], "find": [1, 4], "find_on": 1, "fals": [1, 6], "project": [1, 5, 7], "insert_on": 1, "insert": 1, "singl": 1, "insert_mani": 1, "mani": 1, "update_on": 1, "filter_doc": 1, "update_doc": 1, "updat": [1, 5, 7], "str": [1, 4], "name": [1, 4, 5], "dict": [1, 4], "A": 1, "match": [1, 4, 5, 8], "modif": 1, "appli": [1, 5, 7], "omit": 1, "from": [1, 5, 7], "update_mani": 1, "one": [1, 8], "more": [1, 5], "replace_on": 1, "replac": 1, "given": [1, 4], "assum": 1, "contain": [1, 8], "_id": 1, "which": [1, 4], "filter": 1, "new": [1, 5], "replace_mani": 1, "upsert": 1, "collat": 1, "bulk_writ": 1, "multipl": 1, "replaceon": 1, "oper": [1, 5], "ar": [1, 6, 7, 8], "all": [1, 5, 6, 7], "list": [1, 5, 7], "bool": [1, 6], "perform": 1, "instanc": [1, 6], "onli": [1, 7], "support": [1, 5, 7], "abov": [1, 8], "delete_on": 1, "delet": 1, "delete_mani": 1, "hook": [2, 5, 6, 7], "sensor": [2, 5, 6], "mongosensor": [4, 5, 7], "basesensoroper": 4, "check": [4, 5, 8], "exist": [4, 7], "mongo_sensor": 4, "coll": 4, "kei": [4, 8], "valu": 4, "admin": 4, "task_id": 4, "target": 4, "template_field": [4, 5], "sequenc": [4, 5], "poke": 4, "context": [4, 5], "function": [4, 5, 7], "defin": 4, "while": 4, "deriv": 4, "should": [4, 6, 8], "overrid": 4, "detail": [5, 7, 8], "commit": 5, "chang": 5, "version": [5, 7, 8], "For": [5, 6, 8], "high": 5, "level": 5, "changelog": 5, "see": [5, 7], "inform": [5, 6], "includ": 5, "latest": 5, "2022": 5, "06": 5, "07": 5, "subject": 5, "717a7588bc": 5, "descript": 5, "remov": [5, 7, 8], "doubl": 5, "min": 5, "specif": 5, "24292": 5, "aeabe994b3": 5, "prepar": 5, "mai": 5, "": [5, 8], "releas": [5, 7], "24231": 5, "027b707d21": 5, "05": 5, "add": [5, 7], "explanatori": 5, "note": [5, 6], "contributor": 5, "about": [5, 8], "24229": 5, "75c60923e0": 5, "12": [5, 8], "11": [5, 8], "23631": 5, "2d109401b3": 5, "04": 5, "bump": 5, "pre": 5, "22887": 5, "03": 5, "22": 5, "d7dbfb7e26": 5, "bugfix": 5, "22383": 5, "14": 5, "16adc035b1": 5, "classifi": [5, 7], "march": 5, "22226": 5, "f5b96315fe": 5, "feb": 5, "22056": 5, "d94fa37830": 5, "02": 5, "08": 5, "fix": 5, "januari": 5, "delai": 5, "21439": 5, "6c3a67d4fc": 5, "2021": [5, 8], "21257": 5, "602abe8394": 5, "01": 5, "20": 5, "type": [5, 6, 7], "line": 5, "now": 5, "sphinx": 5, "autoapi": 5, "typehint": 5, "20951": 5, "31": 5, "f77417eb0d": 5, "k8": 5, "pypi": [5, 7], "compat": 5, "20614": 5, "97496ba2b4": 5, "decemb": 5, "20523": 5, "d56e7b56bb": 5, "30": 5, "have": [5, 7], "mypi": 5, "friendli": 5, "20571": 5, "a0821235fb": 5, "everywher": 5, "20565": 5, "853576d901": 5, "novemb": 5, "19882": 5, "fe682ec3d3": 5, "24": 5, "duplic": 5, "entri": 5, "19759": 5, "454ca2ff92": 5, "10": [5, 7], "29": 5, "param": [5, 7], "19280": [5, 7], "d9567eb106": 5, "octob": 5, "19321": 5, "fd569e7144": 5, "28": 5, "19223": [5, 7], "19276": [5, 7], "0a68588479": 5, "august": 5, "17890": 5, "be75dcd39c": 5, "23": 5, "meta": 5, "data": 5, "76ed2a49c6": 5, "19": 5, "import": [5, 7, 8], "lazili": 5, "individu": 5, "manag": [5, 8], "17682": [5, 7], "987575787d": 5, "transfer": [5, 7], "17379": [5, 7], "18": 5, "bbc627a3da": 5, "rc2": 5, "16501": 5, "cbf8001d76": 5, "16": 5, "synchron": 5, "after": [5, 6], "buggfix": 5, "16464": 5, "1fba5402bb": 5, "15": 5, "june": 5, "16405": 5, "9c94b72d44": 5, "16294": 5, "37681bca00": 5, "auto": [5, 7], "apply_default": [5, 7], "decor": [5, 7], "15667": [5, 7], "807ad32ce5": 5, "pip": [5, 7, 8], "21": 5, "15576": 5, "5b2fe0e740": 5, "27": 5, "popular": 5, "15393": 5, "71c673e427": 5, "docstr": 5, "modul": 5, "miss": 5, "15391": 5, "68e4c4dcb0": 5, "backport": 5, "14886": 5, "6e6526a0f6": 5, "13": [5, 7], "broken": 5, "14734": 5, "88bdcfa0df": 5, "wave": 5, "14013": 5, "ac2f72c98d": 5, "implement": 5, "tool": 5, "13767": 5, "3fd5ef3555": 5, "logo": 5, "integr": [5, 6], "13717": 5, "295d66f914": 5, "2020": 5, "grammar": 5, "warn": [5, 8], "13380": 5, "6cf76d7ac0": 5, "typo": 5, "upgrad": [5, 7], "command": 5, "13148": 5, "09": 5, "32971a1a2d": 5, "12955": 5, "b40dffa085": 5, "renam": 5, "rema": 5, "aip": 5, "12917": 5, "9b39f24780": 5, "dynam": 5, "form": 5, "per": 5, "12558": 5, "2037303eef": 5, "discoveri": 5, "12466": 5, "c34ef853c8": 5, "separ": 5, "out": 5, "build": [5, 8], "12444": 5, "0080354502": 5, "readm": [5, 7], "0b2": 5, "batch": 5, "12449": 5, "ae7cb4a1e2": 5, "17": 5, "wrong": 5, "hash": 5, "12390": 5, "6889a333cf": 5, "improv": 5, "ref": 5, "12366": 5, "7825e8f590": 5, "instal": 5, "12304": 5, "85a18e13d9": 5, "point": 5, "page": [5, 8], "cross": 5, "depend": 5, "12212": 5, "59eb5de78c": 5, "up": 5, "come": 5, "0beta1": 5, "12206": 5, "b2a28d1590": 5, "move": 5, "script": [5, 8], "dev": 5, "12082": 5, "41bf172c1d": 5, "simplifi": 5, "express": 5, "12093": 5, "4e8f9cc8d0": 5, "enabl": [5, 6], "black": 5, "python": [5, 7, 8], "formmatt": 5, "9550": 5, "8c42cf1b00": 5, "pyupgrad": 5, "6": [5, 7], "11447": 5, "5a439e84eb": 5, "26": 5, "2a1": 5, "11855": 5, "872b1566a1": 5, "25": 5, "gener": 5, "setup": 5, "11826": 5, "349b0811c3": 5, "d200": 5, "pydocstyl": 5, "11688": 5, "16e7129719": 5, "ad": [5, 7], "11487": 5, "0a0e1af800": 5, "markdown": 5, "link": [5, 8], "toc": 5, "11249": 5, "ca4238eb4d": 5, "month": 5, "11242": 5, "5220e4c384": 5, "11238": 5, "fdd9b6f65b": 5, "10543": 5, "3696c34c28": 5, "word": 5, "10528": 5, "ee7ca128a1": 5, "refernc": 5, "10483": 5, "cdec301254": 5, "correct": [5, 8], "signatur": [5, 8], "10205": 5, "24c8e4c2d6": 5, "constructor": 5, "argument": 5, "10163": 5, "46cdb0e080": 5, "hint": 5, "9875": 5, "d0e7db4024": 5, "number": [5, 6], "fresh": 5, "9408": 5, "12af6a0800": 5, "final": 5, "cleanup": 5, "23rc1": 5, "9404": 5, "c7e5bce57f": 5, "candid": 5, "9370": 5, "f6bd817a3a": 5, "introduc": 5, "9320": 5, "0b0e4f7a4c": 5, "rc3": 5, "relas": 5, "9026": 5, "00642a46d0": 5, "remain": 5, "wrongli": 5, "8994": 5, "375d1ca229": 5, "8898": 5, "12c5e5d8a": 5, "8891": 5, "f3521fb0e3": 5, "regener": 5, "file": [5, 7, 8], "8886": 5, "92585ca4cb": 5, "autom": 5, "8807": 5, "05443c6dc8": 5, "call": 5, "super": 5, "class": [5, 7], "7828": 5, "97a429f9d0": 5, "6714": 5, "magic": 5, "comment": 5, "utf": 5, "8": 5, "7338": 5, "059eda05f8": 5, "6610": 5, "softwar": [5, 8], "7231": 5, "mongo": [6, 8], "some": 6, "relat": 6, "login": 6, "usernam": 6, "wish": 6, "too": 6, "password": 6, "port": 6, "host": 6, "hostnam": 6, "standalon": 6, "ani": [6, 8], "would": 6, "like": 6, "Such": 6, "json": 6, "dictionari": 6, "azur": 6, "follow": [6, 8], "indic": [6, 8], "correspond": 6, "record": 6, "instead": 6, "cert": 6, "rest": 6, "sent": 6, "environ": 6, "variabl": 6, "uri": 6, "syntax": 6, "compon": 6, "url": 6, "encod": 6, "same": 6, "export": 6, "airflow_conn_mongo_default": 6, "27317": 6, "3fauthsourc": 6, "3dadmin": 6, "repositori": 7, "top": [7, 8], "below": [7, 8], "minimum": 7, "via": [7, 8], "dnspython": 7, "avail": [7, 8], "explain": 7, "polici": 7, "github": 7, "blob": 7, "main": [7, 8], "md": 7, "mistakenli": 7, "install_requir": 7, "22382": 7, "trove": 7, "framework": 7, "pin": 7, "20511": 7, "optimis": 7, "due": 7, "first": 7, "least": 7, "otherwis": 7, "automat": 7, "complet": 7, "migrat": 7, "initi": 7, "describ": 8, "download": 8, "apach": 8, "airflow": 8, "provid": 8, "offici": 8, "also": 8, "most": 8, "choos": 8, "differ": 8, "select": 8, "drop": 8, "down": 8, "left": 8, "sdist": 8, "whl": 8, "origin": 8, "checksum": 8, "foundat": 8, "asc": 8, "sha512": 8, "those": 8, "code": 8, "how": 8, "pgp": 8, "It": 8, "essenti": 8, "sha": 8, "gpg": 8, "pleas": 8, "well": 8, "relev": 8, "distribut": 8, "recommend": 8, "get": 8, "directori": 8, "mirror": 8, "pgpk": 8, "ka": 8, "To": 8, "binari": 8, "guid": 8, "pgpv": 8, "tar": 8, "gz": 8, "made": 8, "sat": 8, "sep": 8, "49": 8, "54": 8, "bst": 8, "rsa": 8, "cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f": 8, "issuer": 8, "kaxilnaik": 8, "org": 8, "good": 8, "kaxil": 8, "naik": 8, "unknown": 8, "aka": 8, "gmail": 8, "user": 8, "certifi": 8, "trust": 8, "There": 8, "belong": 8, "owner": 8, "primari": 8, "fingerprint": 8, "cde1": 8, "5c6e": 8, "4d3a": 8, "8ec4": 8, "ecf4": 8, "ba4b": 8, "6674": 8, "e08a": 8, "d7de": 8, "406f": 8, "do": 8, "worri": 8, "certif": 8, "self": 8, "sign": 8, "why": 8, "By": 8, "server": 8, "previou": 8, "step": 8, "know": 8, "valid": 8, "alreadi": 8, "sum": 8, "shasum": 8, "512": 8, "diff": 8, "local": 8, "bin": 8, "bash": 8, "package_vers": 8, "package_nam": 8, "provider_download_dir": 8, "mktemp": 8, "d": 8, "dep": 8, "dest": 8, "curl": 8, "apache_airflow_providers_mongo": 8, "py3": 8, "l": 8, "o": 8, "echo": 8, "la": 8, "onc": 8, "instruct": 8, "chapter": 8, "temporari": 8, "folder": 8, "creat": 8}, "objects": {"airflow.providers": [[2, 0, 0, "-", "mongo"]], "airflow.providers.mongo": [[0, 0, 0, "-", "hooks"], [3, 0, 0, "-", "sensors"]], "airflow.providers.mongo.hooks": [[1, 0, 0, "-", "mongo"]], "airflow.providers.mongo.hooks.mongo": [[1, 1, 1, "", "MongoHook"]], "airflow.providers.mongo.hooks.mongo.MongoHook": [[1, 2, 1, "", "__enter__"], [1, 2, 1, "", "__exit__"], [1, 2, 1, "", "aggregate"], [1, 2, 1, "", "close_conn"], [1, 3, 1, "", "conn_name_attr"], [1, 3, 1, "", "conn_type"], [1, 3, 1, "", "default_conn_name"], [1, 2, 1, "", "delete_many"], [1, 2, 1, "", "delete_one"], [1, 2, 1, "", "find"], [1, 2, 1, "", "get_collection"], [1, 2, 1, "", "get_conn"], [1, 3, 1, "", "hook_name"], [1, 2, 1, "", "insert_many"], [1, 2, 1, "", "insert_one"], [1, 2, 1, "", "replace_many"], [1, 2, 1, "", "replace_one"], [1, 2, 1, "", "update_many"], [1, 2, 1, "", "update_one"]], "airflow.providers.mongo.sensors": [[4, 0, 0, "-", "mongo"]], "airflow.providers.mongo.sensors.mongo": [[4, 1, 1, "", "MongoSensor"]], "airflow.providers.mongo.sensors.mongo.MongoSensor": [[4, 2, 1, "", "poke"], [4, 3, 1, "", "template_fields"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"]}, "titleterms": {"airflow": [0, 1, 2, 3, 4, 5, 7], "provid": [0, 1, 2, 3, 4, 5, 7], "mongo": [0, 1, 2, 3, 4, 5, 7], "hook": [0, 1], "submodul": [0, 3], "modul": [1, 4], "content": [1, 4, 7], "class": [1, 4], "subpackag": 2, "sensor": [3, 4], "packag": [5, 7, 8], "apach": [5, 7], "3": [5, 7], "0": [5, 7], "2": [5, 7], "1": [5, 7], "mongodb": 6, "connect": 6, "authent": 6, "default": 6, "id": 6, "configur": 6, "refer": 7, "resourc": 7, "commit": 7, "instal": [7, 8], "requir": 7, "changelog": 7, "break": 7, "chang": 7, "bug": 7, "fix": 7, "misc": 7, "featur": 7, "from": 8, "sourc": 8, "releas": 8, "integr": 8, "verifi": 8, "pypi": 8}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 56}})