skewsplit 0.1.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 [yyyy] [name of copyright owner]
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,97 @@
1
+ Metadata-Version: 2.4
2
+ Name: skewsplit
3
+ Version: 0.1.0
4
+ Summary: Balanced, index-friendly JDBC partition predicates for Spark, planned from the column's real distribution.
5
+ Keywords: spark,jdbc,postgresql,partitioning,skew,predicates
6
+ Author: The skewsplit authors
7
+ License-Expression: Apache-2.0
8
+ License-File: LICENSE
9
+ Classifier: Development Status :: 2 - Pre-Alpha
10
+ Classifier: Intended Audience :: Developers
11
+ Classifier: Operating System :: OS Independent
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Programming Language :: Python :: 3 :: Only
14
+ Classifier: Programming Language :: Python :: 3.9
15
+ Classifier: Programming Language :: Python :: 3.10
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Programming Language :: Python :: 3.13
19
+ Classifier: Programming Language :: Python :: 3.14
20
+ Classifier: Programming Language :: Python :: 3.15
21
+ Classifier: Topic :: Database
22
+ Classifier: Typing :: Typed
23
+ Requires-Dist: psycopg>=3.2 ; python_full_version < '3.10' and extra == 'postgres'
24
+ Requires-Dist: psycopg>=3.3 ; python_full_version >= '3.10' and extra == 'postgres'
25
+ Requires-Python: >=3.9
26
+ Project-URL: Repository, https://github.com/Diafyx/skewsplit
27
+ Project-URL: Issues, https://github.com/Diafyx/skewsplit/issues
28
+ Provides-Extra: postgres
29
+ Description-Content-Type: text/markdown
30
+
31
+ # skewsplit
32
+
33
+ skewsplit reads a database column's distribution and returns balanced,
34
+ index-friendly range predicates for the `predicates` argument of Spark's JDBC
35
+ reader, together with a report of the remaining skew.
36
+
37
+ For PostgreSQL, it plans from the column's statistics in `pg_stats`, without
38
+ scanning the table. `NULL` rows get their own predicate, a value too frequent
39
+ to split gets its own `col = value` predicate, and the predicates match every
40
+ row exactly once whatever the data.
41
+
42
+ > **Status: early development (pre-alpha).** The API can change in any 0.x
43
+ > release.
44
+
45
+ ## Install
46
+
47
+ ```sh
48
+ pip install "skewsplit[postgres]"
49
+ ```
50
+
51
+ The `postgres` extra installs psycopg, which also needs libpq: add
52
+ `psycopg[binary]` if your system has none.
53
+
54
+ ## Use
55
+
56
+ ```python
57
+ from skewsplit import postgres
58
+
59
+ plan = postgres.plan("host=db dbname=shop user=reader", "public.orders", "customer_id", 16)
60
+ print(plan.report)
61
+ df = spark.read.jdbc(url, "public.orders", predicates=plan.predicates, properties=properties)
62
+ ```
63
+
64
+ The planner itself needs no database:
65
+
66
+ ```python
67
+ >>> import skewsplit
68
+ >>> plan = skewsplit.plan(
69
+ ... {
70
+ ... "column": "customer_id",
71
+ ... "type": "int4",
72
+ ... "null_rows": 100,
73
+ ... "mcv": [{"value": "7", "rows": 60}, {"value": "42", "rows": 500}],
74
+ ... "histogram": {"bounds": ["1", "250", "500", "750", "1000"], "rows": 400},
75
+ ... },
76
+ ... 4,
77
+ ... )
78
+ >>> for predicate in plan.predicates:
79
+ ... print(predicate)
80
+ "customer_id" IS NULL
81
+ "customer_id" < 42
82
+ "customer_id" = 42
83
+ "customer_id" > 42 AND "customer_id" < 520
84
+ "customer_id" >= 520
85
+
86
+ ```
87
+
88
+ From the command line, `skewsplit plan --table public.orders --column
89
+ customer_id --partitions 16` prints the same report, and `--format pyspark`
90
+ prints the code that reads the table.
91
+
92
+ **The output contains real values from the column**: treat plans, reports and
93
+ logs like the data they describe.
94
+
95
+ The [repository](https://github.com/Diafyx/skewsplit#readme) has the full
96
+ documentation: the command line, when to use hash-mod instead, limitations and
97
+ supported versions.
@@ -0,0 +1,67 @@
1
+ # skewsplit
2
+
3
+ skewsplit reads a database column's distribution and returns balanced,
4
+ index-friendly range predicates for the `predicates` argument of Spark's JDBC
5
+ reader, together with a report of the remaining skew.
6
+
7
+ For PostgreSQL, it plans from the column's statistics in `pg_stats`, without
8
+ scanning the table. `NULL` rows get their own predicate, a value too frequent
9
+ to split gets its own `col = value` predicate, and the predicates match every
10
+ row exactly once whatever the data.
11
+
12
+ > **Status: early development (pre-alpha).** The API can change in any 0.x
13
+ > release.
14
+
15
+ ## Install
16
+
17
+ ```sh
18
+ pip install "skewsplit[postgres]"
19
+ ```
20
+
21
+ The `postgres` extra installs psycopg, which also needs libpq: add
22
+ `psycopg[binary]` if your system has none.
23
+
24
+ ## Use
25
+
26
+ ```python
27
+ from skewsplit import postgres
28
+
29
+ plan = postgres.plan("host=db dbname=shop user=reader", "public.orders", "customer_id", 16)
30
+ print(plan.report)
31
+ df = spark.read.jdbc(url, "public.orders", predicates=plan.predicates, properties=properties)
32
+ ```
33
+
34
+ The planner itself needs no database:
35
+
36
+ ```python
37
+ >>> import skewsplit
38
+ >>> plan = skewsplit.plan(
39
+ ... {
40
+ ... "column": "customer_id",
41
+ ... "type": "int4",
42
+ ... "null_rows": 100,
43
+ ... "mcv": [{"value": "7", "rows": 60}, {"value": "42", "rows": 500}],
44
+ ... "histogram": {"bounds": ["1", "250", "500", "750", "1000"], "rows": 400},
45
+ ... },
46
+ ... 4,
47
+ ... )
48
+ >>> for predicate in plan.predicates:
49
+ ... print(predicate)
50
+ "customer_id" IS NULL
51
+ "customer_id" < 42
52
+ "customer_id" = 42
53
+ "customer_id" > 42 AND "customer_id" < 520
54
+ "customer_id" >= 520
55
+
56
+ ```
57
+
58
+ From the command line, `skewsplit plan --table public.orders --column
59
+ customer_id --partitions 16` prints the same report, and `--format pyspark`
60
+ prints the code that reads the table.
61
+
62
+ **The output contains real values from the column**: treat plans, reports and
63
+ logs like the data they describe.
64
+
65
+ The [repository](https://github.com/Diafyx/skewsplit#readme) has the full
66
+ documentation: the command line, when to use hash-mod instead, limitations and
67
+ supported versions.
@@ -0,0 +1,74 @@
1
+ [project]
2
+ name = "skewsplit"
3
+ version = "0.1.0"
4
+ description = "Balanced, index-friendly JDBC partition predicates for Spark, planned from the column's real distribution."
5
+ readme = "README.md"
6
+ license = "Apache-2.0"
7
+ license-files = ["LICENSE"]
8
+ requires-python = ">=3.9"
9
+ dependencies = []
10
+ keywords = [
11
+ "spark",
12
+ "jdbc",
13
+ "postgresql",
14
+ "partitioning",
15
+ "skew",
16
+ "predicates",
17
+ ]
18
+ classifiers = [
19
+ "Development Status :: 2 - Pre-Alpha",
20
+ "Intended Audience :: Developers",
21
+ "Operating System :: OS Independent",
22
+ "Programming Language :: Python :: 3",
23
+ "Programming Language :: Python :: 3 :: Only",
24
+ "Programming Language :: Python :: 3.9",
25
+ "Programming Language :: Python :: 3.10",
26
+ "Programming Language :: Python :: 3.11",
27
+ "Programming Language :: Python :: 3.12",
28
+ "Programming Language :: Python :: 3.13",
29
+ "Programming Language :: Python :: 3.14",
30
+ "Programming Language :: Python :: 3.15",
31
+ "Topic :: Database",
32
+ "Typing :: Typed",
33
+ ]
34
+
35
+ [[project.authors]]
36
+ name = "The skewsplit authors"
37
+
38
+ [project.optional-dependencies]
39
+ postgres = [
40
+ "psycopg>=3.2; python_version<'3.10'",
41
+ "psycopg>=3.3; python_version>='3.10'",
42
+ ]
43
+
44
+ [project.urls]
45
+ Repository = "https://github.com/Diafyx/skewsplit"
46
+ Issues = "https://github.com/Diafyx/skewsplit/issues"
47
+
48
+ [project.scripts]
49
+ skewsplit = "skewsplit.cli:main"
50
+
51
+ [build-system]
52
+ requires = ["uv_build>=0.13.7,<0.14"]
53
+ build-backend = "uv_build"
54
+
55
+ [tool.mutmut]
56
+ source_paths = ["src"]
57
+ only_mutate = ["src/skewsplit/core/*"]
58
+ also_copy = ["tests"]
59
+ pytest_add_cli_args = [
60
+ "-p",
61
+ "no:randomly",
62
+ ]
63
+ pytest_add_cli_args_test_selection = [
64
+ "tests/property",
65
+ "tests/unit/postgres",
66
+ "tests/unit/test_api.py",
67
+ "tests/unit/test_cli.py",
68
+ "tests/unit/test_codecs.py",
69
+ "tests/unit/test_conformance.py",
70
+ "tests/unit/test_inputs.py",
71
+ "tests/unit/test_pgarray.py",
72
+ "tests/unit/test_plan.py",
73
+ "tests/unit/test_planner.py",
74
+ ]
@@ -0,0 +1,67 @@
1
+ [project]
2
+ name = "skewsplit"
3
+ version = "0.1.0"
4
+ description = "Balanced, index-friendly JDBC partition predicates for Spark, planned from the column's real distribution."
5
+ readme = "README.md"
6
+ license = "Apache-2.0"
7
+ license-files = ["LICENSE"]
8
+ authors = [{ name = "The skewsplit authors" }]
9
+ requires-python = ">=3.9"
10
+ dependencies = []
11
+ keywords = ["spark", "jdbc", "postgresql", "partitioning", "skew", "predicates"]
12
+ classifiers = [
13
+ "Development Status :: 2 - Pre-Alpha",
14
+ "Intended Audience :: Developers",
15
+ "Operating System :: OS Independent",
16
+ "Programming Language :: Python :: 3",
17
+ "Programming Language :: Python :: 3 :: Only",
18
+ "Programming Language :: Python :: 3.9",
19
+ "Programming Language :: Python :: 3.10",
20
+ "Programming Language :: Python :: 3.11",
21
+ "Programming Language :: Python :: 3.12",
22
+ "Programming Language :: Python :: 3.13",
23
+ "Programming Language :: Python :: 3.14",
24
+ "Programming Language :: Python :: 3.15",
25
+ "Topic :: Database",
26
+ "Typing :: Typed",
27
+ ]
28
+
29
+ [project.optional-dependencies]
30
+ # The PostgreSQL adapter, skewsplit.postgres. psycopg also needs libpq: install
31
+ # psycopg[binary] as well if the system has none. psycopg 3.3 needs Python 3.10.
32
+ postgres = [
33
+ "psycopg>=3.2; python_version<'3.10'",
34
+ "psycopg>=3.3; python_version>='3.10'",
35
+ ]
36
+
37
+ [project.urls]
38
+ Repository = "https://github.com/Diafyx/skewsplit"
39
+ Issues = "https://github.com/Diafyx/skewsplit/issues"
40
+
41
+ [project.scripts]
42
+ skewsplit = "skewsplit.cli:main"
43
+
44
+ [build-system]
45
+ requires = ["uv_build>=0.13.7,<0.14"]
46
+ build-backend = "uv_build"
47
+
48
+ # make mutation, which only nightly.yml runs, runs mutmut from this folder: it
49
+ # names mutants by their path below src/, as the tests import them. It copies
50
+ # src and the tests to mutants/, mutates the core, and runs pytest there.
51
+ [tool.mutmut]
52
+ source_paths = ["src"]
53
+ only_mutate = ["src/skewsplit/core/*"]
54
+ also_copy = ["tests"]
55
+ pytest_add_cli_args = ["-p", "no:randomly"]
56
+ pytest_add_cli_args_test_selection = [
57
+ "tests/property",
58
+ "tests/unit/postgres",
59
+ "tests/unit/test_api.py",
60
+ "tests/unit/test_cli.py",
61
+ "tests/unit/test_codecs.py",
62
+ "tests/unit/test_conformance.py",
63
+ "tests/unit/test_inputs.py",
64
+ "tests/unit/test_pgarray.py",
65
+ "tests/unit/test_plan.py",
66
+ "tests/unit/test_planner.py",
67
+ ]
@@ -0,0 +1,87 @@
1
+ """Balanced JDBC partition predicates for Spark, planned from column statistics.
2
+
3
+ :func:`plan` plans from a distribution you already have. To plan from a
4
+ PostgreSQL table's statistics, see :mod:`skewsplit.postgres`.
5
+ """
6
+
7
+ from __future__ import annotations
8
+
9
+ from importlib.metadata import version
10
+ from typing import TYPE_CHECKING
11
+
12
+ from skewsplit.core import planner
13
+ from skewsplit.core.errors import SpecError
14
+ from skewsplit.core.plan import Bound, Plan, PlanWarning, Predicate
15
+
16
+ if TYPE_CHECKING:
17
+ from collections.abc import Mapping
18
+
19
+ __all__ = [
20
+ "Bound",
21
+ "Plan",
22
+ "PlanWarning",
23
+ "Predicate",
24
+ "SpecError",
25
+ "__version__",
26
+ "plan",
27
+ ]
28
+
29
+ __version__: str = version("skewsplit")
30
+
31
+
32
+ def plan(distribution: Mapping[str, object], partitions: int) -> Plan:
33
+ """Plan ``partitions`` predicates from a column's distribution.
34
+
35
+ Args:
36
+ distribution: The input of spec section 1 without ``partitions``: the
37
+ column's name and type, its NULL rows, its most common values and
38
+ a histogram of the other rows, with values in the type's text form.
39
+ partitions: The most predicates to plan besides the NULL predicate,
40
+ 1 to 10000.
41
+
42
+ Raises:
43
+ SpecError: If the input is invalid, with the code of spec section 9.
44
+
45
+ >>> import skewsplit
46
+ >>> result = skewsplit.plan(
47
+ ... {
48
+ ... "column": "customer_id",
49
+ ... "type": "int4",
50
+ ... "null_rows": 100,
51
+ ... "mcv": [{"value": "7", "rows": 60}, {"value": "42", "rows": 500}],
52
+ ... "histogram": {"bounds": ["1", "250", "500", "750", "1000"], "rows": 400},
53
+ ... },
54
+ ... 4,
55
+ ... )
56
+
57
+ ``predicates`` is the list Spark's JDBC reader takes, one partition each:
58
+
59
+ >>> result.predicates[:3]
60
+ ['"customer_id" IS NULL', '"customer_id" < 42', '"customer_id" = 42']
61
+
62
+ ``report`` shows the estimated rows of each and the warnings:
63
+
64
+ >>> print(result.report) # doctest: +ELLIPSIS
65
+ customer_id (int4): 1060 estimated rows, 4 of 4 partitions plus one for NULL, skew score 1.887
66
+ rows predicate
67
+ 100 "customer_id" IS NULL
68
+ 76 "customer_id" < 42
69
+ 500 "customer_id" = 42
70
+ 192 "customer_id" > 42 AND "customer_id" < 520
71
+ 192 "customer_id" >= 520
72
+ warning dominant_value: 42 holds 500 rows, ...
73
+
74
+ ``to_dict`` and ``to_json`` give the output of spec section 10:
75
+
76
+ >>> result.to_dict()["skew_score"]
77
+ 1.887
78
+ >>> import json
79
+ >>> json.loads(result.to_json()) == result.to_dict()
80
+ True
81
+ """
82
+ if "partitions" in distribution:
83
+ error = SpecError(
84
+ "invalid_input", "give partitions as the argument of plan(), not in the distribution"
85
+ )
86
+ raise error
87
+ return planner.plan({**distribution, "partitions": partitions})
@@ -0,0 +1,5 @@
1
+ """Allow ``python -m skewsplit``."""
2
+
3
+ from skewsplit.cli import main
4
+
5
+ raise SystemExit(main())