pgpack-dumper 0.3.0.0__cp314-cp314-macosx_11_0_arm64.whl

pgpack_dumper-0.3.0.0.dist-info/METADATA

@@ -0,0 +1,201 @@
+Metadata-Version: 2.4
+Name: pgpack_dumper
+Version: 0.3.0.0
+Summary: Library for read and write PGPack format between PostgreSQL and file.
+Author-email: 0xMihalich <bayanmobile87@gmail.com>
+Project-URL: Homepage, https://github.com/0xMihalich/pgpack_dumper
+Project-URL: Documentation, https://github.com/0xMihalich/pgpack_dumper#readme
+Project-URL: Repository, https://github.com/0xMihalich/pgpack_dumper
+Project-URL: Changelog, https://github.com/0xMihalich/pgpack_dumper/blob/main/CHANGELOG.md
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pgpack==0.3.0.9
+Requires-Dist: psycopg_binary>=3.2.11
+Requires-Dist: psycopg>=3.2.11
+Requires-Dist: sqlparse>=0.5.3
+Dynamic: license-file
+
+# PGPackDumper
+
+Library for read and write PGPack format between PostgreSQL and file
+
+## Examples
+
+### Initialization
+
+```python
+from pgpack_dumper import (
+    CompressionMethod,
+    PGConnector,
+    PGPackDumper,
+)
+
+connector = PGConnector(
+    host = <your host>,
+    dbname = <your database>,
+    user = <your username>,
+    password = <your password>,
+    port = <your port>,
+)
+
+dumper = PGPackDumper(
+    connector=connector,
+    compression_method=CompressionMethod.ZSTD,  # or CompressionMethod.LZ4 or CompressionMethod.NONE
+)
+```
+
+### Read dump from PostgreSQL into file
+
+```python
+file_name = "test_table.pgpack"
+# you need define one of parameter query or table_name
+query = "select ..."  # some sql query
+table_name = "public.test_table"  # or some table
+
+with open(file_name, "wb") as fileobj:
+    dumper.read_dump(
+        fileobj,
+        query,
+        table_name,
+    )
+```
+
+### Write dump from file into PostgreSQL
+
+```python
+file_name = "test_table.pgpack"
+# you need define one of parameter table_name
+table_name = "public.test_table"  # some table
+
+with open(file_name, "rb") as fileobj:
+    dumper.write_dump(
+        fileobj,
+        table_name,
+    )
+```
+
+### Write from PostgreSQL into PostgreSQL
+
+Same server
+
+```python
+
+table_dest = "public.test_table_write"  # some table for write
+table_src = "public.test_table_read"  # some table for read
+query_src = "select ..."  # or some sql query for read
+
+dumper.write_between(
+    table_dest,
+    table_src,
+    query_src,
+)
+```
+
+Different servers
+
+```python
+
+connector_src = PGConnector(
+    host = <host src>,
+    dbname = <database src>,
+    user = <username src>,
+    password = <password src>,
+    port = <port src>,
+)
+
+dumper_src = PGPackDumper(connector=connector_src)
+
+table_dest = "public.test_table_write"  # some table for write
+table_src = "public.test_table_read"  # some table for read
+query_src = "select ..."  # or some sql query for read
+
+dumper.write_between(
+    table_dest,
+    table_src,
+    query_src,
+    dumper_src,
+)
+```
+
+### Get stream object
+
+```python
+# you need define one of parameter query or table_name
+query = "select ..."  # some sql query
+table_name = "public.test_table"  # or some table
+reader = dumper.to_reader(query=query, table_name=table_name)
+print(reader)
+# <PostgreSQL/GreenPlum stream reader>
+# ┌─────────────────┬─────────────────┐
+# │ Column Name     │ PostgreSQL Type │
+# ╞═════════════════╪═════════════════╡
+# │ column1         │ date            │
+# │-----------------+-----------------│
+# │ column2         │ bpchar          │
+# │-----------------+-----------------│
+# │ column3         │ bpchar          │
+# └─────────────────┴─────────────────┘
+# Total columns: 3
+# Readed rows: 0
+```
+
+StreamReader has three methods available,
+but only one of the methods is available at a time within a single session.
+
+```python
+# read as python generator object
+reader.to_rows()
+# or read as pandas.DataFrame
+reader.to_pandas()
+# or read as polars.DataFrame
+reader.to_polars()
+```
+
+### Write from python objects into target table
+
+```python
+# some table for write data
+table_name = "public.test_table"
+dtype_data: Itarable[Any]
+pandas_frame: pandas.DataFrame
+polars_frame: polars.DataFrame
+
+# write from python object
+dumper.from_rows(dtype_data, table_name)
+# write from pandas.DataFrame
+dumper.from_pandas(pandas_frame, table_name)
+# write from polars.DataFrame
+dumper.from_polars(polars_frame, table_name)
+```
+
+### Open PGPack file format
+
+Get info from my another repository https://github.com/0xMihalich/pgpack
+
+## Installation
+
+### From pip
+
+```bash
+pip install pgpack-dumper
+```
+
+### From local directory
+
+```bash
+pip install .
+```
+
+### From git
+
+```bash
+pip install git+https://github.com/0xMihalich/pgpack_dumper
+```

pgpack_dumper-0.3.0.0.dist-info/RECORD

@@ -0,0 +1,30 @@
+pgpack_dumper-0.3.0.0.dist-info/RECORD,,
+pgpack_dumper-0.3.0.0.dist-info/WHEEL,sha256=2Id6qreet5t4wZv58bZfijJ58qrc2xkw6OVvWfeqxV0,136
+pgpack_dumper-0.3.0.0.dist-info/top_level.txt,sha256=AhxLKWTyGtJWNLWUSyBu54xY4wjVS8vSXgW4wwq4bYk,14
+pgpack_dumper-0.3.0.0.dist-info/METADATA,sha256=m8GpfNmtDaxEgZW-imd67SfDs_LXTlOsL6ZBuvuJe6s,5069
+pgpack_dumper-0.3.0.0.dist-info/licenses/LICENSE,sha256=9IYMxtPlcVkrfjeRPA9GRUmaQkLG_FL-Gx7HxLvcLDQ,1067
+pgpack_dumper/version.py,sha256=QjDEkJ4u3QAQZ3CwLE5X_wJEerb9U3SSlJbnhJdcrxg,24
+pgpack_dumper/__init__.py,sha256=2x9LRaKPMjMuOoP9pBAeSRZoAeCo9B8fxFbnW_N7kh8,966
+pgpack_dumper/dumper.py,sha256=5WnXg69hszHjzPXRoAMAvFY5ZrVsKVtx48XMsLDG0og,14261
+pgpack_dumper/common/metadata.py,sha256=Z_vbgi1V85jgPR0h1xbUtt3Ru7vMcmG06bd13Gn_ocY,864
+pgpack_dumper/common/diagram.py,sha256=2w5-s5qwYjCd0cqqlBRbHQ8E90jU7Ay7TNLeROHjCa0,2505
+pgpack_dumper/common/query.py,sha256=5kMXFJvBWCKW3hYfqsI7F1qc1I786IPNGIhMXypIv1E,1359
+pgpack_dumper/common/reader.pyx,sha256=vRIR558enMtx4gueWtoujJbpRoWbKnLWx_foVR-rxIw,1821
+pgpack_dumper/common/__init__.py,sha256=gz-xk9TgMHVx5hlFnipO3kuLp7k3grb-OhoSP5Y7LvU,1242
+pgpack_dumper/common/copy.py,sha256=3mzGGVOVMdnUXqmpdXu3THQJpJB85D9LQN-MC-LX-fg,4941
+pgpack_dumper/common/logger.py,sha256=gsFCOjnCU3Hvg5UGYMVrPjKRCZKRFtBFBX-7QLZshFo,1675
+pgpack_dumper/common/stream.py,sha256=PXWcxmDmuK7ueI3MTUfQnmXKWz3A99W-knNRvq_-ZG0,2245
+pgpack_dumper/common/columns.py,sha256=Pa8bzhoi8tXbm3GlgVeHYM3auPORD41q-L29JF_pRqM,693
+pgpack_dumper/common/structs.py,sha256=gS7vT-_yZ6R45j212B0kYKCJgHalxkdEN84Itctv7Ok,1033
+pgpack_dumper/common/connector.py,sha256=WGBovyXWxgeseGXploUW0L_4R0GQBtuInl89zqvbKLY,176
+pgpack_dumper/common/reader.pxd,sha256=flQddQni7UgYU_XPGpnILc7GVDFYjRgq-tbKRTUPbE8,252
+pgpack_dumper/common/reader.pyi,sha256=UoW-mEAw_G7TLBbIoPTJwpdtucv5IygHdkHc_ZcVM5Y,675
+pgpack_dumper/common/errors.py,sha256=1WIe9PUq5-Q6VNWyWAaXWr7xuXS2ixJCUB5sDOi5Xgs,591
+pgpack_dumper/common/reader.cpython-314-darwin.so,sha256=D4MiEQQkIkHFJZnXnf9OfVzk7PiAdnOG-9fja1XwFO8,115872
+pgpack_dumper/common/queryes/copy_from.sql,sha256=hEHfzW7P9-q74jtgMMA94kGpiMeyURs0pnFLbmqgdW0,50
+pgpack_dumper/common/queryes/gpversion.sql,sha256=iUwW40pFCVAZhDZ6ah8CIW75_KMBLyvUxMyqOI7vxtA,80
+pgpack_dumper/common/queryes/relkind.sql,sha256=wpyWaIiuCqQ0YaFPsNAEwwxSxuErNnRmP__-bfZ1vho,66
+pgpack_dumper/common/queryes/copy_to.sql,sha256=AUSsFl_WFB88UcC45SLd8lD_1La1MIkV2CKX-gCOxEE,49
+pgpack_dumper/common/queryes/attributes.sql,sha256=TriT025-yo7k9Bba3mKmpEYZiutE6ml4-5pAnGMemSg,394
+pgpack_dumper/common/queryes/dbname.sql,sha256=Z3b6a_566PxA52ywRJw1JDSCUMC_c-FyulvW8mC1C7c,141
+pgpack_dumper/common/queryes/prepare.sql,sha256=oqRk3GU0gjFzM0nLNsKWeD8GfeThZVKsFiMY1-tdb8g,182

pgpack_dumper-0.3.0.0.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: false
+Tag: cp314-cp314-macosx_11_0_arm64
+Generator: delocate 0.13.0
+

pgpack_dumper-0.3.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 0xMihalich
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pgpack_dumper-0.3.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pgpack_dumper