mkpipe-loader-influxdb 0.2.0__tar.gz

mkpipe_loader_influxdb-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023-2024 Metin Karakus
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

mkpipe_loader_influxdb-0.2.0/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: mkpipe-loader-influxdb
+Version: 0.2.0
+Summary: InfluxDB loader for mkpipe.
+Author: Metin Karakus
+Author-email: metin_karakus@yahoo.com
+License: Apache License 2.0
+Requires-Python: >=3.9
+License-File: LICENSE
+Requires-Dist: mkpipe
+Requires-Dist: influxdb-client
+Dynamic: author
+Dynamic: author-email
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

mkpipe_loader_influxdb-0.2.0/README.md

@@ -0,0 +1,123 @@
+# mkpipe-loader-influxdb
+
+InfluxDB loader plugin for [MkPipe](https://github.com/mkpipe-etl/mkpipe). Writes Spark DataFrames into InfluxDB as time-series data points using `influxdb-client` write API.
+
+## Documentation
+
+For more detailed documentation, please visit the [GitHub repository](https://github.com/mkpipe-etl/mkpipe).
+
+## License
+
+This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.
+
+---
+
+## Connection Configuration
+
+```yaml
+connections:
+  influxdb_target:
+    variant: influxdb
+    host: localhost
+    port: 8086
+    database: my_bucket
+    api_key: my-influx-token
+    extra:
+      org: my-org
+      time_column: _time         # column to use as InfluxDB timestamp (default: _time)
+      tag_columns: [host, region] # columns written as InfluxDB tags
+      field_columns: [cpu, mem]   # columns written as fields (all non-tag, non-time if omitted)
+```
+
+---
+
+## Table Configuration
+
+```yaml
+pipelines:
+  - name: pg_to_influxdb
+    source: pg_source
+    destination: influxdb_target
+    tables:
+      - name: public.metrics
+        target_name: cpu_usage
+        replication_method: full
+        batchsize: 5000
+```
+
+---
+
+## Write Strategy
+
+Control how data is written to InfluxDB:
+
+```yaml
+      - name: public.metrics
+        target_name: cpu_usage
+        write_strategy: upsert       # append | replace | upsert
+```
+
+| Strategy | InfluxDB Behavior |
+|---|---|
+| `append` | Write data points (default for incremental) |
+| `replace` | Delete the measurement (all time range), then write (default for full) |
+| `upsert` | Same as `append` — InfluxDB naturally deduplicates by timestamp + tag set. Writing a point with the same timestamp and tags overwrites the existing point. |
+
+> **Note:** InfluxDB uses timestamp + tag set as a natural primary key. `write_key` is not required — deduplication happens automatically.
+
+---
+
+## Column Mapping
+
+Rows from the DataFrame are written as InfluxDB line protocol points:
+
+| DataFrame column | InfluxDB role | How to configure |
+|---|---|---|
+| `time_column` value | Point timestamp | `extra.time_column` (default: `_time`) |
+| `tag_columns` values | Tags (indexed) | `extra.tag_columns: [col1, col2]` |
+| All other columns | Fields (values) | Default; or restrict via `extra.field_columns` |
+
+Auto-added columns (`etl_time`, `mkpipe_id`) are excluded from fields.
+
+---
+
+## Write Throughput
+
+`batchsize` controls how many rows are sent per write API call:
+
+```yaml
+      - name: public.metrics
+        target_name: cpu_usage
+        replication_method: full
+        batchsize: 10000    # default: 10000 points per write call
+```
+
+### Performance Notes
+
+- Write throughput is limited by the InfluxDB server and network. Larger `batchsize` reduces round-trips.
+- 5,000–10,000 points per batch is a safe default for most deployments.
+- All data is collected on the Spark driver (`df.collect()`) before writing — not suitable for datasets larger than available driver memory.
+
+---
+
+## All Table Parameters
+
+| Parameter | Type | Default | Description |
+|---|---|---|---|
+| `name` | string | required | Source table name |
+| `target_name` | string | required | InfluxDB measurement name to write into |
+| `replication_method` | `full` / `incremental` | `full` | Replication strategy |
+| `batchsize` | int | `10000` | Points per write API call |
+| `write_strategy` | string | — | `append`, `replace`, `upsert` |
+| `dedup_columns` | list | — | Columns used for `mkpipe_id` hash deduplication |
+| `tags` | list | `[]` | Tags for selective pipeline execution |
+| `pass_on_error` | bool | `false` | Skip table on error instead of failing |
+
+### Extra Connection Parameters
+
+| Key | Default | Description |
+|---|---|---|
+| `org` | `""` | InfluxDB organization name |
+| `time_column` | `_time` | Column used as the point timestamp |
+| `tag_columns` | `[]` | Columns written as InfluxDB tags (indexed, string values) |
+| `field_columns` | `[]` | Columns written as fields (if empty, all non-tag/non-time columns) |

mkpipe_loader_influxdb-0.2.0/mkpipe_loader_influxdb/__init__.py

@@ -0,0 +1,118 @@
+import gc
+from datetime import datetime
+
+from mkpipe.exceptions import ConfigError, LoadError
+from mkpipe.models import ConnectionConfig, ExtractResult, TableConfig, WriteStrategy
+from mkpipe.spark.base import BaseLoader
+from mkpipe.spark.columns import add_etl_columns
+from mkpipe.strategy import resolve_write_strategy
+from mkpipe.utils import get_logger
+
+logger = get_logger(__name__)
+
+
+class InfluxDBLoader(BaseLoader, variant='influxdb'):
+    def __init__(self, connection: ConnectionConfig):
+        self.connection = connection
+        self.host = connection.host or 'localhost'
+        self.port = connection.port or 8086
+        self.token = connection.api_key or connection.oauth_token
+        self.org = connection.extra.get('org', '')
+        self.bucket = connection.database
+
+    def load(self, table: TableConfig, data: ExtractResult, spark) -> None:
+        target_name = table.target_name
+        df = data.df
+
+        if df is None:
+            logger.info({'table': target_name, 'status': 'skipped', 'reason': 'no data'})
+            return
+
+        df = add_etl_columns(df, datetime.now(), dedup_columns=table.dedup_columns)
+
+        strategy = resolve_write_strategy(table, data)
+
+        logger.info({
+            'table': target_name,
+            'status': 'loading',
+            'write_strategy': strategy.value,
+        })
+
+        try:
+            from influxdb_client import InfluxDBClient
+            from influxdb_client.client.write_api import SYNCHRONOUS
+
+            url = f'http://{self.host}:{self.port}'
+            client = InfluxDBClient(url=url, token=self.token, org=self.org)
+
+            match strategy:
+                case WriteStrategy.REPLACE:
+                    delete_api = client.delete_api()
+                    delete_api.delete(
+                        start='1970-01-01T00:00:00Z',
+                        stop='2099-12-31T23:59:59Z',
+                        predicate=f'_measurement="{target_name}"',
+                        bucket=self.bucket,
+                        org=self.org,
+                    )
+                    logger.info({'table': target_name, 'status': 'measurement_deleted'})
+                case WriteStrategy.APPEND | WriteStrategy.UPSERT:
+                    pass
+                case _:
+                    raise ConfigError(
+                        f"InfluxDB loader does not support write_strategy: {strategy.value}"
+                    )
+
+            write_api = client.write_api(write_options=SYNCHRONOUS)
+
+            tag_columns = self.connection.extra.get('tag_columns', [])
+            field_columns = self.connection.extra.get('field_columns', [])
+            time_column = self.connection.extra.get('time_column', '_time')
+
+            rows = [row.asDict(recursive=True) for row in df.collect()]
+            batchsize = table.batchsize or 10000
+
+            for i in range(0, len(rows), batchsize):
+                batch = rows[i:i + batchsize]
+                points = []
+                for row in batch:
+                    tags = {k: str(row[k]) for k in tag_columns if k in row and row[k] is not None}
+                    time_val = row.get(time_column)
+
+                    fields = {}
+                    if field_columns:
+                        fields = {k: row[k] for k in field_columns if k in row and row[k] is not None}
+                    else:
+                        skip = set(tag_columns) | {time_column, '_measurement', 'etl_time', 'mkpipe_id'}
+                        fields = {k: v for k, v in row.items() if k not in skip and v is not None}
+
+                    if not fields:
+                        continue
+
+                    point = {
+                        'measurement': target_name,
+                        'tags': tags,
+                        'fields': fields,
+                    }
+                    if time_val:
+                        point['time'] = str(time_val)
+                    points.append(point)
+
+                if points:
+                    write_api.write(bucket=self.bucket, org=self.org, record=points)
+
+            write_api.close()
+            client.close()
+        except (ConfigError, LoadError):
+            raise
+        except Exception as e:
+            raise LoadError(f"Failed to write '{target_name}': {e}") from e
+
+        df.unpersist()
+        gc.collect()
+
+        logger.info({
+            'table': target_name,
+            'status': 'loaded',
+            'rows': len(rows),
+        })

mkpipe_loader_influxdb-0.2.0/mkpipe_loader_influxdb.egg-info/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: mkpipe-loader-influxdb
+Version: 0.2.0
+Summary: InfluxDB loader for mkpipe.
+Author: Metin Karakus
+Author-email: metin_karakus@yahoo.com
+License: Apache License 2.0
+Requires-Python: >=3.9
+License-File: LICENSE
+Requires-Dist: mkpipe
+Requires-Dist: influxdb-client
+Dynamic: author
+Dynamic: author-email
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

mkpipe_loader_influxdb-0.2.0/mkpipe_loader_influxdb.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+setup.py
+mkpipe_loader_influxdb/__init__.py
+mkpipe_loader_influxdb.egg-info/PKG-INFO
+mkpipe_loader_influxdb.egg-info/SOURCES.txt
+mkpipe_loader_influxdb.egg-info/dependency_links.txt
+mkpipe_loader_influxdb.egg-info/entry_points.txt
+mkpipe_loader_influxdb.egg-info/requires.txt
+mkpipe_loader_influxdb.egg-info/top_level.txt

mkpipe_loader_influxdb-0.2.0/mkpipe_loader_influxdb.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

mkpipe_loader_influxdb-0.2.0/mkpipe_loader_influxdb.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[mkpipe.loaders]
+influxdb = mkpipe_loader_influxdb:InfluxDBLoader

mkpipe_loader_influxdb-0.2.0/mkpipe_loader_influxdb.egg-info/requires.txt

@@ -0,0 +1,2 @@
+mkpipe
+influxdb-client

mkpipe_loader_influxdb-0.2.0/mkpipe_loader_influxdb.egg-info/top_level.txt

@@ -0,0 +1 @@
+mkpipe_loader_influxdb

mkpipe_loader_influxdb-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

mkpipe_loader_influxdb-0.2.0/setup.py

@@ -0,0 +1,19 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='mkpipe-loader-influxdb',
+    version='0.2.0',
+    license='Apache License 2.0',
+    packages=find_packages(),
+    install_requires=['mkpipe', 'influxdb-client'],
+    include_package_data=True,
+    entry_points={
+        'mkpipe.loaders': [
+            'influxdb = mkpipe_loader_influxdb:InfluxDBLoader',
+        ],
+    },
+    description='InfluxDB loader for mkpipe.',
+    author='Metin Karakus',
+    author_email='metin_karakus@yahoo.com',
+    python_requires='>=3.9',
+)