echoss-db 1.2.2__tar.gz → 1.2.4__tar.gz

echoss_db-1.2.4/LICENSE

@@ -0,0 +1,157 @@
+Apache License
+Version 2.0, January 2004
+https://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.

{echoss_db-1.2.2 → echoss_db-1.2.4}/MANIFEST.in

@@ -2,7 +2,10 @@ include README.md
 include LICENSE
 include requirements.txt
 exclude config/
-include tutorial *.ipynb
+recursive-include tutorial *.py *.ipynb
+recursive-include package_tests *.py
+recursive-exclude tutorial .ipynb_checkpoints/*
+recursive-exclude tutorial *.env
 recursive-exclude * __pycache__/
 recursive-exclude * *.log *.log.*
 recursive-exclude * .*.un~

{echoss_db-1.2.2 → echoss_db-1.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: echoss-db
-Version: 1.2.2
+Version: 1.2.4
 Summary: echoss AI Bigdata Solution - Database Query Package
 Home-page: https://github.com/12cmlab/echoss-query
 Author: ckkim
@@ -8,15 +8,17 @@ Author-email: ckkim@12cm.co.kr
 License: Apache License 2.0
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
-Requires-Python: >3.7
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: pandas>=1.5.3
 Requires-Dist: pymongo>=4.3.3
 Requires-Dist: sqlalchemy>=2.0.0
 Requires-Dist: PyMySQL>=1.0.2
-Requires-Dist: PyYAML>=6.0
 Requires-Dist: opensearch-py>=2.2.0
 Requires-Dist: echoss-fileformat>=1.1.2
+Requires-Dist: psycopg2-binary<3.0.0,>=2.9.11
+Requires-Dist: qdrant-client[fastembed]<2.0.0,>=1.14.1
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -24,6 +26,7 @@ Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: license
+Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
@@ -38,6 +41,7 @@ Version History:
 
 - 1.1.0 : Add Scroll, Bulk functions in ElasticSearch
 - 1.2.0 : change mysql base package to sqlalchemy (previous version use pymysql)
+- 1.2.4 : stabilize package imports for optional backends and keep PostgreSQL on psycopg2-binary for 1.2.x
 
 ## Prepare
 
@@ -79,6 +83,18 @@ To install this package, please use Python 3.8 or higher.
     pip install -U echoss-db
 ```
 
+PostgreSQL driver policy for `1.2.x`:
+
+- `psycopg2-binary` is the supported PostgreSQL driver for this release line.
+- `psycopg` / `psycopg-binary` (psycopg3) is not part of the `1.2.x` compatibility target.
+- If your application environment has both psycopg2 and psycopg3 installed, `echoss-db 1.2.x` will still use the psycopg2 SQLAlchemy dialect.
+
+Dependency compatibility note:
+
+- `echoss-db 1.2.x` does not pin `Pillow` directly.
+- Qdrant support installs `qdrant-client[fastembed]`, so mixed environments may inherit additional `Pillow` constraints through `fastembed`.
+- If your application also installs `echoss-storage`, align the shared environment with the `echoss-storage` line you are deploying. For `echoss-storage 1.2.1`, use `Pillow>=10.1.0,<11`.
+
 ## Quick Start
 
 ### Import package and class
@@ -136,15 +152,12 @@ To install this package, please use Python 3.8 or higher.
     # Ping
     mysql.ping()
 
-    # get connection cursor
-    mysql.conn_cursor(cursorclass=None)
-
     # Close
     # crash process close
     mysql.close()
 
     # debug query : default True
-    mysql.debug_query(False)
+    mysql.query_debug(False)
 ```
 
 ### MongoDB
@@ -196,7 +209,7 @@ To install this package, please use Python 3.8 or higher.
     elastic.search_field(field='FIELD_NAME',value='VALUE') -> list
 
     # INSERT
-    elastic.create(id='ID', body='JSON_BODY')
+    elastic.index(index='INDEX_NAME', body='JSON_BODY', id='ID')
 
     #UPDATE
     elastic.update(id='ID', body='JSON_BODY')
@@ -209,8 +222,8 @@ To install this package, please use Python 3.8 or higher.
     chunk_list = elastic.next_scroll_chunk()
 
     # BULK 
-    success, error_list = bulk_insert("farm_index", doc_list, id_field="farm_id")
-    success, error_list = bulk_upsert("farm_index", doc_list, id_field="farm_id")
+    success, error_list = elastic.bulk_insert("farm_index", doc_list, id_field="farm_id")
+    success, error_list = elastic.bulk_upsert("farm_index", doc_list, id_field="farm_id")
   
     # Ping
     elastic.ping()
@@ -219,6 +232,77 @@ To install this package, please use Python 3.8 or higher.
     elastic.info()
 ```
 
+### Qdrant
+
+---
+
+`QdrantVector`는 기본적으로 FastEmbed 모델을 사용합니다.
+
+Tutorial 실행 순서:
+1. `tutorial/example_postgres_qdrant_ingest.py` (테스트용 충분한 chunk 데이터 생성)
+2. `tutorial/example_qdrant.py` (Qdrant 업서트/검색 확인)
+
+1. `fastembed_model` 미설정
+- 기본값 `sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2`가 자동 적용됩니다.
+- 단, 설치된 `qdrant-client/fastembed` 조합에서 미지원일 수 있으므로 아래 메서드로 확인하세요.
+  - 모델 상세(설명 포함) 목록: `list_supported_models_by_class("TextEmbedding")`
+- `vector` 입력 없이 원문 텍스트(`document`/`text`/`content`)를 전달합니다.
+- 명시 메서드 `upsert_texts()` / `search_text()` 사용을 권장합니다.
+- `create_collection()`의 차원은 모델에서 자동 추론합니다.
+
+2. `fastembed_model` 설정
+- 지정한 모델로 동작합니다.
+- `create_collection()`의 차원은 설정 모델 기준으로 자동 추론합니다.
+
+3. `fastembed_model: null`
+- FastEmbed를 비활성화하고 벡터 직접 주입 모드로 동작합니다.
+- 이 경우 `upsert_vectors()` / `search_vector()` 사용을 권장합니다.
+- `create_collection(dim=...)`에서 `dim`은 필수입니다.
+
+Config example:
+
+```yaml
+qdrant:
+  host: <IP addrress or domain>
+  port: 6333
+  scheme: http
+  collection: ai_rag_chunks
+  timeout: 5
+  default_limit: 10
+  fastembed_model: sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2
+```
+
+Text-input upsert example (`fastembed_model` enabled):
+
+```python
+points = [
+    {"id": 1, "document": "RAG 시스템 설계 문서", "payload": {"source": "wiki"}},
+    {"id": 2, "text": "Qdrant 검색 예제", "payload": {"source": "blog"}},
+]
+qv.upsert_texts(points, collection="ai_rag_chunks")
+
+hits = qv.search_text(query_text="RAG 아키텍처", limit=5, collection="ai_rag_chunks")
+```
+
+External vector-input mode is documented as a code pattern only (for lightweight tutorial runtime):
+
+```python
+qv = QdrantVector({
+    "qdrant": {
+        "host": "<host>",
+        "port": 6333,
+        "scheme": "http",
+        "collection": "ai_rag_chunks_external",
+        "fastembed_model": None
+    }
+})
+
+points = [{"id": 1, "vector": your_embed_fn("문서"), "payload": {"source": "external"}}]
+qv.create_collection(dim=len(points[0]["vector"]))
+qv.upsert_vectors(points)
+hits = qv.search_vector(vector=your_embed_fn("질의"))
+```
+
 ### Code Quality
 
 When creating new functions, please follow the Google style Python docstrings. See example below:

{echoss_db-1.2.2 → echoss_db-1.2.4}/README.md

@@ -8,6 +8,7 @@ Version History:
 
 - 1.1.0 : Add Scroll, Bulk functions in ElasticSearch
 - 1.2.0 : change mysql base package to sqlalchemy (previous version use pymysql)
+- 1.2.4 : stabilize package imports for optional backends and keep PostgreSQL on psycopg2-binary for 1.2.x
 
 ## Prepare
 
@@ -49,6 +50,18 @@ To install this package, please use Python 3.8 or higher.
     pip install -U echoss-db
 ```
 
+PostgreSQL driver policy for `1.2.x`:
+
+- `psycopg2-binary` is the supported PostgreSQL driver for this release line.
+- `psycopg` / `psycopg-binary` (psycopg3) is not part of the `1.2.x` compatibility target.
+- If your application environment has both psycopg2 and psycopg3 installed, `echoss-db 1.2.x` will still use the psycopg2 SQLAlchemy dialect.
+
+Dependency compatibility note:
+
+- `echoss-db 1.2.x` does not pin `Pillow` directly.
+- Qdrant support installs `qdrant-client[fastembed]`, so mixed environments may inherit additional `Pillow` constraints through `fastembed`.
+- If your application also installs `echoss-storage`, align the shared environment with the `echoss-storage` line you are deploying. For `echoss-storage 1.2.1`, use `Pillow>=10.1.0,<11`.
+
 ## Quick Start
 
 ### Import package and class
@@ -106,15 +119,12 @@ To install this package, please use Python 3.8 or higher.
     # Ping
     mysql.ping()
 
-    # get connection cursor
-    mysql.conn_cursor(cursorclass=None)
-
     # Close
     # crash process close
     mysql.close()
 
     # debug query : default True
-    mysql.debug_query(False)
+    mysql.query_debug(False)
 ```
 
 ### MongoDB
@@ -166,7 +176,7 @@ To install this package, please use Python 3.8 or higher.
     elastic.search_field(field='FIELD_NAME',value='VALUE') -> list
 
     # INSERT
-    elastic.create(id='ID', body='JSON_BODY')
+    elastic.index(index='INDEX_NAME', body='JSON_BODY', id='ID')
 
     #UPDATE
     elastic.update(id='ID', body='JSON_BODY')
@@ -179,8 +189,8 @@ To install this package, please use Python 3.8 or higher.
     chunk_list = elastic.next_scroll_chunk()
 
     # BULK 
-    success, error_list = bulk_insert("farm_index", doc_list, id_field="farm_id")
-    success, error_list = bulk_upsert("farm_index", doc_list, id_field="farm_id")
+    success, error_list = elastic.bulk_insert("farm_index", doc_list, id_field="farm_id")
+    success, error_list = elastic.bulk_upsert("farm_index", doc_list, id_field="farm_id")
   
     # Ping
     elastic.ping()
@@ -189,6 +199,77 @@ To install this package, please use Python 3.8 or higher.
     elastic.info()
 ```
 
+### Qdrant
+
+---
+
+`QdrantVector`는 기본적으로 FastEmbed 모델을 사용합니다.
+
+Tutorial 실행 순서:
+1. `tutorial/example_postgres_qdrant_ingest.py` (테스트용 충분한 chunk 데이터 생성)
+2. `tutorial/example_qdrant.py` (Qdrant 업서트/검색 확인)
+
+1. `fastembed_model` 미설정
+- 기본값 `sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2`가 자동 적용됩니다.
+- 단, 설치된 `qdrant-client/fastembed` 조합에서 미지원일 수 있으므로 아래 메서드로 확인하세요.
+  - 모델 상세(설명 포함) 목록: `list_supported_models_by_class("TextEmbedding")`
+- `vector` 입력 없이 원문 텍스트(`document`/`text`/`content`)를 전달합니다.
+- 명시 메서드 `upsert_texts()` / `search_text()` 사용을 권장합니다.
+- `create_collection()`의 차원은 모델에서 자동 추론합니다.
+
+2. `fastembed_model` 설정
+- 지정한 모델로 동작합니다.
+- `create_collection()`의 차원은 설정 모델 기준으로 자동 추론합니다.
+
+3. `fastembed_model: null`
+- FastEmbed를 비활성화하고 벡터 직접 주입 모드로 동작합니다.
+- 이 경우 `upsert_vectors()` / `search_vector()` 사용을 권장합니다.
+- `create_collection(dim=...)`에서 `dim`은 필수입니다.
+
+Config example:
+
+```yaml
+qdrant:
+  host: <IP addrress or domain>
+  port: 6333
+  scheme: http
+  collection: ai_rag_chunks
+  timeout: 5
+  default_limit: 10
+  fastembed_model: sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2
+```
+
+Text-input upsert example (`fastembed_model` enabled):
+
+```python
+points = [
+    {"id": 1, "document": "RAG 시스템 설계 문서", "payload": {"source": "wiki"}},
+    {"id": 2, "text": "Qdrant 검색 예제", "payload": {"source": "blog"}},
+]
+qv.upsert_texts(points, collection="ai_rag_chunks")
+
+hits = qv.search_text(query_text="RAG 아키텍처", limit=5, collection="ai_rag_chunks")
+```
+
+External vector-input mode is documented as a code pattern only (for lightweight tutorial runtime):
+
+```python
+qv = QdrantVector({
+    "qdrant": {
+        "host": "<host>",
+        "port": 6333,
+        "scheme": "http",
+        "collection": "ai_rag_chunks_external",
+        "fastembed_model": None
+    }
+})
+
+points = [{"id": 1, "vector": your_embed_fn("문서"), "payload": {"source": "external"}}]
+qv.create_collection(dim=len(points[0]["vector"]))
+qv.upsert_vectors(points)
+hits = qv.search_vector(vector=your_embed_fn("질의"))
+```
+
 ### Code Quality
 
 When creating new functions, please follow the Google style Python docstrings. See example below:

echoss_db-1.2.4/echoss_db/__init__.py

@@ -0,0 +1,34 @@
+from __future__ import annotations
+
+from importlib import import_module
+
+__all__ = [
+    "MysqlQuery",
+    "MongoQuery",
+    "ElasticSearch",
+    "PostgresQuery",
+    "QdrantVector",
+]
+
+_EXPORTS = {
+    "MysqlQuery": ".mysql_query",
+    "MongoQuery": ".mongo_query",
+    "ElasticSearch": ".elastic_search",
+    "PostgresQuery": ".postgres_query",
+    "QdrantVector": ".qdrant_vector",
+}
+
+
+def __getattr__(name: str):
+    module_name = _EXPORTS.get(name)
+    if module_name is None:
+        raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+    module = import_module(module_name, __name__)
+    value = getattr(module, name)
+    globals()[name] = value
+    return value
+
+
+def __dir__():
+    return sorted(list(globals().keys()) + __all__)