pacificdb 1.2.0rc2__tar.gz

pacificdb-1.2.0rc2/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

pacificdb-1.2.0rc2/PKG-INFO

@@ -0,0 +1,134 @@
+Metadata-Version: 2.4
+Name: pacificdb
+Version: 1.2.0rc2
+Summary: Database-first PacificDB Community client with verified pooled connections and streaming transfers
+Author: PacificDB contributors
+License-Expression: Apache-2.0
+Project-URL: Source, https://github.com/hitesh-reddy-k/pacificdb-community
+Project-URL: Issues, https://github.com/hitesh-reddy-k/pacificdb-community/issues
+Project-URL: Documentation, https://github.com/hitesh-reddy-k/pacificdb-community/tree/v1.2.0-rc.2/sdk/python
+Classifier: Programming Language :: Python :: 3
+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: Operating System :: OS Independent
+Classifier: Topic :: Database
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+![PacificDB](https://raw.githubusercontent.com/hitesh-reddy-k/pacificdb-community/main/site/assets/pacificdb-logo-symbol.png)
+
+# PacificDB Python client
+
+Version **1.2.0rc2 — prerelease**. Download the matching package from the
+[Community v1.2.0-rc.2 release](https://github.com/hitesh-reddy-k/pacificdb-community/releases/tag/v1.2.0-rc.2);
+registry publication is pending.
+
+A database-first client for the Community engine. Requires Python 3.10 or later;
+no runtime dependencies. These examples describe the 1.2.0-rc.2 prerelease. The new
+APIs require its published wheel or tagged-source build, not an older registry release.
+
+Start a PacificDB server, then connect to a database directly:
+
+```python
+import os
+from pacificdb import PacificDB, PacificDBError
+
+url = os.environ.get('PACIFICDB_URL', 'pacificdb://localhost:9000/app')
+with PacificDB.connect(url) as db:
+    db.create_database()             # create the URL's database and select it
+    db.create_collection('users')
+    db.insert('users', {'id': '1', 'name': 'Ada'})
+    print(db.find_one('users', {'id': '1'}))
+    db.update_one('users', {'id': '1'}, {'$set': {'name': 'Grace'}})
+    print(db.count('users'))
+```
+
+Create calls are not implicit or idempotent: omit them when the database or
+collection already exists. No project or separate selection call is required.
+The existing `PacificDBClient(host, port, user_id, database, use_tls, ca_file,
+timeout)` constructor still works. `PacificDB` is its shorter alias.
+
+`connect(url, **options)` eagerly authenticates URL credentials and checks the
+connection with `ping`; `from_url(url, **options)` connects lazily on the first
+request. URL credentials must contain both username and password. Use an
+environment variable for private URLs, not a literal in source or logs. Use
+`pacificdbs://` for TLS with verified hostname and default trust, or provide
+`ca_file='/path/to/ca.pem'`. Authentication on plain TCP does not encrypt traffic.
+
+URL defaults: port 9000, user `system`, 30-second deadline, pool size 16. Query
+keys are `userId`, `timeoutMs`, `poolSize`, `caFile`; duplicate/unknown keys and
+conflicting explicit options fail before connecting. Python options use
+`user_id`, `timeout` (seconds), `pool_size`, `ca_file`. Pools are limited to 32;
+responses default to a 64 MiB limit (`max_response_bytes` can lower it). Idle
+connections are reused only when the engine explicitly advertises keepalive.
+
+Database methods: `create_database(name=None, db_type='binary')`,
+`list_databases()`, `use_database(name)`, `drop_database(name=None)`. Creation
+selects on success; switching checks the engine's authorized listing. Failed
+create/switch/drop calls preserve selection; dropping the selected database
+clears it. `create_collection`, `list_collections`, and `drop_collection` operate
+on the selected database.
+
+Document methods: `insert`, `insert_many`, `find`, `find_one`, `count`,
+`aggregate`, `explain`, `update_one`, `update_many`, `delete_one`, `delete_many`,
+`bulk_write`. `find(collection, filter=None, limit=-1, offset=0)` returns the
+original engine response; `find_one` returns the first document or `None`.
+`list_databases` returns a list of names. Other methods preserve protocol
+responses, including partial bulk results. Use `capabilities()` for the server's
+feature report, and `request({...})` for raw protocol access. The engine remains
+responsible for namespace rules and authorization.
+
+Every operation snapshots selected scope and caller JSON before network I/O.
+Do not mutate input while the method itself is copying it. Selection is shared
+client state; use separate clients when independent concurrent selection is
+needed. A completed drop cannot clear a newer selection of another database.
+
+`PacificDBError` preserves `.code` and a sanitized `.response`. Known
+credentials are redacted from error diagnostics. Successful document values are
+unchanged. A disconnect/timeout after sending a write can have an unknown
+outcome: **writes are never silently retried**. The deadline covers pool waiting
+and socket I/O; OS DNS resolution can exceed it. `close()` is idempotent and
+wakes queued calls; always use a context manager or close explicitly.
+
+
+## Media and backups
+
+```python
+from pathlib import Path
+
+# Small in-memory attachments; normal collection documents.
+db.media.put('assets', 'logo', b'\x00\xff', {'contentType': 'image/png'})
+attachment = db.media.get('assets', 'logo')  # data: bytes, metadata: dict
+
+# Files are hashed and transferred in bounded chunks.
+manifest = db.media.upload_file('assets', Path('video.mp4'))
+db.media.download_file(manifest['id'], Path('download.mp4'), collection='assets')
+backup = db.backups.create(description='before maintenance')
+db.backups.export(backup['backup_id'], Path('backup.json'))
+```
+
+On interrupted uploads, catch `MediaUploadError` and inspect `upload_id`,
+`next_chunk`, `received_chunks`, `received_bytes` and `resumable`. Resume
+explicitly with the same file, collection and chunk setting:
+`db.media.upload_file('assets', path, resume=error.upload_id)`.
+A lost acknowledgement can mean a chunk was stored; resume asks the server
+which chunks exist and skips them. It never replays a write automatically.
+
+Uploads reject empty/nonregular files and changed content. File downloads
+require a selected database and validate the returned database/optional
+collection, chunk sizes/indexes/base64/SHA-256 and whole file. Downloads and
+backup exports write a private unique sibling temporary file, then replace
+the destination only after verification. The parent directory must exist.
+Backup export streams the existing `pacificdb-full-backup-v1` JSON format;
+it is not an engine restore API. Filesystem errors are typed errors.
+Each network call has a deadline; an entire multi-chunk transfer has no single
+overall deadline. In-memory attachments allocate the supplied bytes; use the
+file APIs for large media.
+
+Apache-2.0. Stable-release and registry qualification remain separate.
+
+Advanced named operations and wire aliases are documented in [SDK capabilities](https://github.com/hitesh-reddy-k/pacificdb-community/blob/main/docs/SDK_CAPABILITIES.md).

pacificdb-1.2.0rc2/README.md

@@ -0,0 +1,113 @@
+![PacificDB](https://raw.githubusercontent.com/hitesh-reddy-k/pacificdb-community/main/site/assets/pacificdb-logo-symbol.png)
+
+# PacificDB Python client
+
+Version **1.2.0rc2 — prerelease**. Download the matching package from the
+[Community v1.2.0-rc.2 release](https://github.com/hitesh-reddy-k/pacificdb-community/releases/tag/v1.2.0-rc.2);
+registry publication is pending.
+
+A database-first client for the Community engine. Requires Python 3.10 or later;
+no runtime dependencies. These examples describe the 1.2.0-rc.2 prerelease. The new
+APIs require its published wheel or tagged-source build, not an older registry release.
+
+Start a PacificDB server, then connect to a database directly:
+
+```python
+import os
+from pacificdb import PacificDB, PacificDBError
+
+url = os.environ.get('PACIFICDB_URL', 'pacificdb://localhost:9000/app')
+with PacificDB.connect(url) as db:
+    db.create_database()             # create the URL's database and select it
+    db.create_collection('users')
+    db.insert('users', {'id': '1', 'name': 'Ada'})
+    print(db.find_one('users', {'id': '1'}))
+    db.update_one('users', {'id': '1'}, {'$set': {'name': 'Grace'}})
+    print(db.count('users'))
+```
+
+Create calls are not implicit or idempotent: omit them when the database or
+collection already exists. No project or separate selection call is required.
+The existing `PacificDBClient(host, port, user_id, database, use_tls, ca_file,
+timeout)` constructor still works. `PacificDB` is its shorter alias.
+
+`connect(url, **options)` eagerly authenticates URL credentials and checks the
+connection with `ping`; `from_url(url, **options)` connects lazily on the first
+request. URL credentials must contain both username and password. Use an
+environment variable for private URLs, not a literal in source or logs. Use
+`pacificdbs://` for TLS with verified hostname and default trust, or provide
+`ca_file='/path/to/ca.pem'`. Authentication on plain TCP does not encrypt traffic.
+
+URL defaults: port 9000, user `system`, 30-second deadline, pool size 16. Query
+keys are `userId`, `timeoutMs`, `poolSize`, `caFile`; duplicate/unknown keys and
+conflicting explicit options fail before connecting. Python options use
+`user_id`, `timeout` (seconds), `pool_size`, `ca_file`. Pools are limited to 32;
+responses default to a 64 MiB limit (`max_response_bytes` can lower it). Idle
+connections are reused only when the engine explicitly advertises keepalive.
+
+Database methods: `create_database(name=None, db_type='binary')`,
+`list_databases()`, `use_database(name)`, `drop_database(name=None)`. Creation
+selects on success; switching checks the engine's authorized listing. Failed
+create/switch/drop calls preserve selection; dropping the selected database
+clears it. `create_collection`, `list_collections`, and `drop_collection` operate
+on the selected database.
+
+Document methods: `insert`, `insert_many`, `find`, `find_one`, `count`,
+`aggregate`, `explain`, `update_one`, `update_many`, `delete_one`, `delete_many`,
+`bulk_write`. `find(collection, filter=None, limit=-1, offset=0)` returns the
+original engine response; `find_one` returns the first document or `None`.
+`list_databases` returns a list of names. Other methods preserve protocol
+responses, including partial bulk results. Use `capabilities()` for the server's
+feature report, and `request({...})` for raw protocol access. The engine remains
+responsible for namespace rules and authorization.
+
+Every operation snapshots selected scope and caller JSON before network I/O.
+Do not mutate input while the method itself is copying it. Selection is shared
+client state; use separate clients when independent concurrent selection is
+needed. A completed drop cannot clear a newer selection of another database.
+
+`PacificDBError` preserves `.code` and a sanitized `.response`. Known
+credentials are redacted from error diagnostics. Successful document values are
+unchanged. A disconnect/timeout after sending a write can have an unknown
+outcome: **writes are never silently retried**. The deadline covers pool waiting
+and socket I/O; OS DNS resolution can exceed it. `close()` is idempotent and
+wakes queued calls; always use a context manager or close explicitly.
+
+
+## Media and backups
+
+```python
+from pathlib import Path
+
+# Small in-memory attachments; normal collection documents.
+db.media.put('assets', 'logo', b'\x00\xff', {'contentType': 'image/png'})
+attachment = db.media.get('assets', 'logo')  # data: bytes, metadata: dict
+
+# Files are hashed and transferred in bounded chunks.
+manifest = db.media.upload_file('assets', Path('video.mp4'))
+db.media.download_file(manifest['id'], Path('download.mp4'), collection='assets')
+backup = db.backups.create(description='before maintenance')
+db.backups.export(backup['backup_id'], Path('backup.json'))
+```
+
+On interrupted uploads, catch `MediaUploadError` and inspect `upload_id`,
+`next_chunk`, `received_chunks`, `received_bytes` and `resumable`. Resume
+explicitly with the same file, collection and chunk setting:
+`db.media.upload_file('assets', path, resume=error.upload_id)`.
+A lost acknowledgement can mean a chunk was stored; resume asks the server
+which chunks exist and skips them. It never replays a write automatically.
+
+Uploads reject empty/nonregular files and changed content. File downloads
+require a selected database and validate the returned database/optional
+collection, chunk sizes/indexes/base64/SHA-256 and whole file. Downloads and
+backup exports write a private unique sibling temporary file, then replace
+the destination only after verification. The parent directory must exist.
+Backup export streams the existing `pacificdb-full-backup-v1` JSON format;
+it is not an engine restore API. Filesystem errors are typed errors.
+Each network call has a deadline; an entire multi-chunk transfer has no single
+overall deadline. In-memory attachments allocate the supplied bytes; use the
+file APIs for large media.
+
+Apache-2.0. Stable-release and registry qualification remain separate.
+
+Advanced named operations and wire aliases are documented in [SDK capabilities](https://github.com/hitesh-reddy-k/pacificdb-community/blob/main/docs/SDK_CAPABILITIES.md).

pacificdb-1.2.0rc2/pacificdb/__init__.py

@@ -0,0 +1,9 @@
+from .client import PacificDBClient
+from .connection import parse_connection_url
+from .errors import PacificDBError, MediaUploadError
+
+PacificDB = PacificDBClient
+__all__ = ["PacificDB", "PacificDBClient", "PacificDBError", "MediaUploadError", "parse_connection_url"]
+
+__version__ = '1.2.0rc2'
+release_info = {'version': '1.2.0', 'releaseVersion': '1.2.0-rc.2', 'name': 'Pre-release v1.2', 'channel': 'prerelease', 'tag': 'v1.2.0-rc.2'}