oceanbase-sqlalchemy 0.2.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2024 OceanBase
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,182 @@
1
+ Metadata-Version: 2.4
2
+ Name: oceanbase-sqlalchemy
3
+ Version: 0.2.0
4
+ Summary: SQLAlchemy dialect for OceanBase Oracle mode (supports SQLAlchemy 1.3.x and 2.0+)
5
+ Home-page: https://github.com/oceanbase/ecology-plugins
6
+ Author: OceanBase Team
7
+ Author-email: support@oceanbase.com
8
+ Project-URL: Bug Reports, https://github.com/oceanbase/ecology-plugins/issues
9
+ Project-URL: Source, https://github.com/oceanbase/ecology-plugins
10
+ Project-URL: Documentation, https://github.com/oceanbase/ecology-plugins#readme
11
+ Keywords: sqlalchemy oceanbase oracle dialect database
12
+ Classifier: Development Status :: 4 - Beta
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: License :: OSI Approved :: Apache Software License
15
+ Classifier: Operating System :: OS Independent
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.7
18
+ Classifier: Programming Language :: Python :: 3.8
19
+ Classifier: Programming Language :: Python :: 3.9
20
+ Classifier: Programming Language :: Python :: 3.10
21
+ Classifier: Programming Language :: Python :: 3.11
22
+ Classifier: Programming Language :: Python :: 3.12
23
+ Classifier: Topic :: Database
24
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
25
+ Requires-Python: >=3.7
26
+ Description-Content-Type: text/markdown
27
+ License-File: LICENSE
28
+ Requires-Dist: sqlalchemy>=1.3.0
29
+ Requires-Dist: cx_oracle>=8.0.0
30
+ Dynamic: author
31
+ Dynamic: author-email
32
+ Dynamic: classifier
33
+ Dynamic: description
34
+ Dynamic: description-content-type
35
+ Dynamic: home-page
36
+ Dynamic: keywords
37
+ Dynamic: license-file
38
+ Dynamic: project-url
39
+ Dynamic: requires-dist
40
+ Dynamic: requires-python
41
+ Dynamic: summary
42
+
43
+ # SQLAlchemy OceanBase Dialect
44
+
45
+ [![PyPI version](https://badge.fury.io/py/oceanbase-sqlalchemy.svg)](https://badge.fury.io/py/oceanbase-sqlalchemy)
46
+ [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
47
+ [![Python](https://img.shields.io/badge/python-3.7%2B-blue.svg)](https://www.python.org/downloads/)
48
+
49
+ A SQLAlchemy dialect for OceanBase Oracle mode, providing seamless integration between SQLAlchemy and OceanBase database.
50
+
51
+ ## Features
52
+
53
+ - **Full Compatibility**: Supports SQLAlchemy 1.3.x and 2.0+
54
+ - **Optimized Performance**: Enhanced SQL queries specifically optimized for OceanBase
55
+ - **Advanced Reflection**: Enhanced constraint reflection with OceanBase-specific optimizations
56
+ - **Connection Safety**: Secure connection string building utilities
57
+
58
+ ## Installation
59
+
60
+ ### From PyPI (Recommended)
61
+
62
+ ```bash
63
+ pip install oceanbase-sqlalchemy
64
+ ```
65
+
66
+ ### From Source
67
+
68
+ ```bash
69
+ git clone https://github.com/oceanbase/ecology-plugins.git
70
+ cd ecology-plugins/oceanbase-sqlalchemy-plugin
71
+ pip install -e .
72
+ ```
73
+
74
+ ## Quick Start
75
+
76
+ ### Basic Usage
77
+
78
+ ```python
79
+ from sqlalchemy import create_engine, text
80
+ from oceanbase_sqlalchemy.utils import build_safe_connection_string
81
+
82
+ # Build connection string
83
+ connection_string = build_safe_connection_string(
84
+ username="your_username",
85
+ password="your_password",
86
+ host="your_host",
87
+ port="2881",
88
+ service_name="your_service_name"
89
+ )
90
+
91
+ # Create engine
92
+ engine = create_engine(connection_string)
93
+
94
+ # Test connection
95
+ with engine.connect() as conn:
96
+ result = conn.execute(text("SELECT 1 FROM DUAL"))
97
+ print(result.fetchone())
98
+ ```
99
+
100
+ ### Using with SQLAlchemy ORM
101
+
102
+ ```python
103
+ from sqlalchemy import create_engine, Column, Integer, String, MetaData, Table
104
+ from sqlalchemy.ext.declarative import declarative_base
105
+ from oceanbase_sqlalchemy.utils import build_safe_connection_string
106
+
107
+ # Create engine
108
+ connection_string = build_safe_connection_string(
109
+ username="your_username",
110
+ password="your_password",
111
+ host="your_host",
112
+ port="2881",
113
+ service_name="your_service_name"
114
+ )
115
+ engine = create_engine(connection_string)
116
+
117
+ # Define model
118
+ Base = declarative_base()
119
+
120
+ class User(Base):
121
+ __tablename__ = 'users'
122
+
123
+ id = Column(Integer, primary_key=True)
124
+ name = Column(String(50))
125
+ email = Column(String(100))
126
+
127
+ # Create tables
128
+ Base.metadata.create_all(engine)
129
+ ```
130
+
131
+
132
+ ## Requirements
133
+
134
+ - Python 3.7+
135
+ - SQLAlchemy 1.3.x or 2.0+
136
+ - cx_Oracle (for Oracle mode)
137
+
138
+ ## Contributing
139
+
140
+ We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
141
+
142
+ 1. Fork the repository
143
+ 2. Create your feature branch (`git checkout -b feature/amazing-feature`)
144
+ 3. Commit your changes (`git commit -m 'Add some amazing feature'`)
145
+ 4. Push to the branch (`git push origin feature/amazing-feature`)
146
+ 5. Open a Pull Request
147
+
148
+
149
+ ## License
150
+
151
+ This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
152
+
153
+ ## Support
154
+
155
+ - **Issues**: [GitHub Issues](https://github.com/oceanbase/ecology-plugins/issues)
156
+ - **Community**: [OceanBase Community](https://www.oceanbase.com/community)
157
+
158
+
159
+ ## FAQ
160
+
161
+ ### Q: How to connect to OceanBase MySQL mode?
162
+ A: The current version only supports OceanBase Oracle mode. For MySQL mode, please use the standard MySQL driver.
163
+
164
+ ### Q: Which SQLAlchemy versions are supported?
165
+ A: Supports SQLAlchemy 1.3.x and 2.0+ versions.
166
+
167
+
168
+ ## Troubleshooting
169
+
170
+ ### Connection Issues
171
+ - Check network connection and firewall settings
172
+ - Verify username, password and service name
173
+ - Confirm the port number is correct (default 2881)
174
+
175
+ ### Performance Issues
176
+ - Enable SQL logging (`echo=True`) to view executed SQL
177
+ - Analyze slow query logs
178
+
179
+ ### Compatibility Issues
180
+ - Ensure using supported SQLAlchemy version
181
+ - Check cx_Oracle driver version
182
+ - Review OceanBase version compatibility
@@ -0,0 +1,140 @@
1
+ # SQLAlchemy OceanBase Dialect
2
+
3
+ [![PyPI version](https://badge.fury.io/py/oceanbase-sqlalchemy.svg)](https://badge.fury.io/py/oceanbase-sqlalchemy)
4
+ [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
5
+ [![Python](https://img.shields.io/badge/python-3.7%2B-blue.svg)](https://www.python.org/downloads/)
6
+
7
+ A SQLAlchemy dialect for OceanBase Oracle mode, providing seamless integration between SQLAlchemy and OceanBase database.
8
+
9
+ ## Features
10
+
11
+ - **Full Compatibility**: Supports SQLAlchemy 1.3.x and 2.0+
12
+ - **Optimized Performance**: Enhanced SQL queries specifically optimized for OceanBase
13
+ - **Advanced Reflection**: Enhanced constraint reflection with OceanBase-specific optimizations
14
+ - **Connection Safety**: Secure connection string building utilities
15
+
16
+ ## Installation
17
+
18
+ ### From PyPI (Recommended)
19
+
20
+ ```bash
21
+ pip install oceanbase-sqlalchemy
22
+ ```
23
+
24
+ ### From Source
25
+
26
+ ```bash
27
+ git clone https://github.com/oceanbase/ecology-plugins.git
28
+ cd ecology-plugins/oceanbase-sqlalchemy-plugin
29
+ pip install -e .
30
+ ```
31
+
32
+ ## Quick Start
33
+
34
+ ### Basic Usage
35
+
36
+ ```python
37
+ from sqlalchemy import create_engine, text
38
+ from oceanbase_sqlalchemy.utils import build_safe_connection_string
39
+
40
+ # Build connection string
41
+ connection_string = build_safe_connection_string(
42
+ username="your_username",
43
+ password="your_password",
44
+ host="your_host",
45
+ port="2881",
46
+ service_name="your_service_name"
47
+ )
48
+
49
+ # Create engine
50
+ engine = create_engine(connection_string)
51
+
52
+ # Test connection
53
+ with engine.connect() as conn:
54
+ result = conn.execute(text("SELECT 1 FROM DUAL"))
55
+ print(result.fetchone())
56
+ ```
57
+
58
+ ### Using with SQLAlchemy ORM
59
+
60
+ ```python
61
+ from sqlalchemy import create_engine, Column, Integer, String, MetaData, Table
62
+ from sqlalchemy.ext.declarative import declarative_base
63
+ from oceanbase_sqlalchemy.utils import build_safe_connection_string
64
+
65
+ # Create engine
66
+ connection_string = build_safe_connection_string(
67
+ username="your_username",
68
+ password="your_password",
69
+ host="your_host",
70
+ port="2881",
71
+ service_name="your_service_name"
72
+ )
73
+ engine = create_engine(connection_string)
74
+
75
+ # Define model
76
+ Base = declarative_base()
77
+
78
+ class User(Base):
79
+ __tablename__ = 'users'
80
+
81
+ id = Column(Integer, primary_key=True)
82
+ name = Column(String(50))
83
+ email = Column(String(100))
84
+
85
+ # Create tables
86
+ Base.metadata.create_all(engine)
87
+ ```
88
+
89
+
90
+ ## Requirements
91
+
92
+ - Python 3.7+
93
+ - SQLAlchemy 1.3.x or 2.0+
94
+ - cx_Oracle (for Oracle mode)
95
+
96
+ ## Contributing
97
+
98
+ We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
99
+
100
+ 1. Fork the repository
101
+ 2. Create your feature branch (`git checkout -b feature/amazing-feature`)
102
+ 3. Commit your changes (`git commit -m 'Add some amazing feature'`)
103
+ 4. Push to the branch (`git push origin feature/amazing-feature`)
104
+ 5. Open a Pull Request
105
+
106
+
107
+ ## License
108
+
109
+ This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
110
+
111
+ ## Support
112
+
113
+ - **Issues**: [GitHub Issues](https://github.com/oceanbase/ecology-plugins/issues)
114
+ - **Community**: [OceanBase Community](https://www.oceanbase.com/community)
115
+
116
+
117
+ ## FAQ
118
+
119
+ ### Q: How to connect to OceanBase MySQL mode?
120
+ A: The current version only supports OceanBase Oracle mode. For MySQL mode, please use the standard MySQL driver.
121
+
122
+ ### Q: Which SQLAlchemy versions are supported?
123
+ A: Supports SQLAlchemy 1.3.x and 2.0+ versions.
124
+
125
+
126
+ ## Troubleshooting
127
+
128
+ ### Connection Issues
129
+ - Check network connection and firewall settings
130
+ - Verify username, password and service name
131
+ - Confirm the port number is correct (default 2881)
132
+
133
+ ### Performance Issues
134
+ - Enable SQL logging (`echo=True`) to view executed SQL
135
+ - Analyze slow query logs
136
+
137
+ ### Compatibility Issues
138
+ - Ensure using supported SQLAlchemy version
139
+ - Check cx_Oracle driver version
140
+ - Review OceanBase version compatibility
@@ -0,0 +1,20 @@
1
+ # -*- coding: utf-8 -*-
2
+ """
3
+ SQLAlchemy dialect for OceanBase Oracle mode.
4
+
5
+ This dialect extends SQLAlchemy's Oracle dialect with OceanBase-specific
6
+ optimizations and features for cx_oracle driver.
7
+ """
8
+
9
+ # Import the cx_oracle dialect class
10
+ from .cx_oracle import OceanBaseDialect_cx_oracle
11
+ from .cx_oceanbase import OceanBaseDialect_cx_oceanbase
12
+
13
+ # Manually register the dialect for SQLAlchemy 2.0 compatibility
14
+ try:
15
+ from sqlalchemy.dialects import registry
16
+
17
+ registry.impls["oceanbase.cx_oracle"] = lambda: OceanBaseDialect_cx_oracle
18
+ registry.impls["oceanbase.cx_oceanbase"] = lambda: OceanBaseDialect_cx_oceanbase
19
+ except ImportError:
20
+ pass
@@ -0,0 +1,15 @@
1
+ # -*- coding: utf-8 -*-
2
+ """
3
+ OceanBase dialect for cx_oceanbase driver.
4
+ """
5
+
6
+ from .cx_oracle import OceanBaseDialect_cx_oracle
7
+
8
+
9
+ class OceanBaseDialect_cx_oceanbase(OceanBaseDialect_cx_oracle):
10
+ """
11
+ OceanBase dialect for cx_oracle driver.
12
+ """
13
+
14
+ name = "oceanbase"
15
+ driver = "cx_oceanbase"