sql-blocks 0.0.1__tar.gz

sql_blocks-0.0.1/LICENSE

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

sql_blocks-0.0.1/PKG-INFO

@@ -0,0 +1,296 @@
+Metadata-Version: 2.1
+Name: sql_blocks
+Version: 0.0.1
+Summary: Allows you to create objects for parts of SQL query commands. Also to combine these objects by joining them, adding or removing parts...
+Home-page: https://github.com/julio-cascalles/sql_blocks
+Author: Júlio Cascalles
+Author-email: Julio Cascalles <julio.cascalles@outlook.com>
+Project-URL: Homepage, https://github.com/julio-cascalles/sql_blocks
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# SQL_Blocks
+
+### 1 - You can assemble a simple object that will then be converted into an SQL command:
+
+> a = Select('Actor') # --> SELECT * FROM Actor act
+
+_Note that an alias "act" has been added._
+
+You can specify your own alias:  `a = Select('Actor a')`
+
+---
+### 2 - You can also add a field, like this...
+
+* a = Select('Actor a', **name=Field**)
+
+* Here are another ways to add a field:
+    - Select('Actor a', name=Distinct )
+
+    - Select('Actor a', name=NamedField('actors_name'))
+
+    - Select(
+        'Actor a', 
+        name=NamedField('actors_name'), Distinct
+    )
+
+---
+
+### 3 - To set conditions, use **Where**:
+* For example, `a = Select(... age=Where.gt(45) )`
+
+    Some possible conditions:
+    * field=Where.eq(value) - ...the field is EQUAL to the value;
+    * field=Where.gt(value) - ...the field is GREATER than the value;
+    * field=Where.lt(value) - ...the field is LESS than the value;
+
+    3.1 -- If you want to filter the field on a range of values:
+    
+    `a = Select( 'Actor a', age=Between(45, 69) )`
+
+    3.2 -- Sub-queries:
+
+```
+query = Select('Movie m', title=Field,
+    id=SubSelect(
+        'Review r',
+        rate=Where.gt(4.5),
+        movie_id=Distinct
+    )
+)
+```
+
+**>> print(query)** 
+
+        SELECT
+            m.title
+        FROM
+            Movie m
+        WHERE
+            m.id IN (
+                SELECT DISTINCT r.movie
+                FROM Review r WHERE r.rate > 4.5
+            )
+    
+3.3 -- Optional conditions:
+```
+    OR=Options(
+        genre=Where.eq("Sci-Fi"),
+        awards=Where.like("Oscar")
+    )
+```
+> Could be AND=Options(...)
+
+---
+### 4 - A field can be two things at the same time:
+
+* m = Select('Movie m' release_date=[Field, OrderBy])
+    - This means that the field will appear in the results and also that the query will be ordered by that field.
+* Applying **GROUP BY** to item 3.2, it would look like this:
+    ```    
+    SubSelect(
+        'Review r', movie=[GroupBy, Distinct],
+        rate=Having.avg(Where.gt(4.5))
+    )
+    ```
+---
+### 5 - Relationships:
+```
+    query = Select('Actor a', name=Field,
+        cast=Select('Cast c', id=PrimaryKey)
+    )
+```
+**>> print(query)**    
+```
+SELECT
+    a.name
+FROM
+    Actor a
+    JOIN Cast c ON (a.cast = c.id)    
+```
+
+---
+### 6 - The reverse process (parse):
+```
+text = """
+        SELECT
+                cas.role,
+                m.title,
+                m.release_date,
+                a.name as actors_name
+        FROM
+                Actor a
+                LEFT JOIN Cast cas ON (a.cast = cas.id)
+                LEFT JOIN Movie m ON (cas.movie = m.id)
+        WHERE
+                (
+                    m.genre = 'Sci-Fi'
+                    OR
+                    m.awards LIKE '%Oscar%'
+                )
+                AND a.age <= 69 AND a.age >= 45
+        ORDER BY
+                m.release_date DESC
+"""
+```
+
+`a, c, m = Select.parse(text)`
+
+**6.1  --- print(a)**
+```
+    SELECT
+            a.name as actors_name
+    FROM
+            Actor a
+    WHERE
+            a.age <= 69
+            AND a.age >= 45
+```
+
+**6.2 --- print(c)**
+
+    SELECT
+            c.role
+    FROM
+            Cast c
+
+**6.3 --- print(m)**
+
+    SELECT
+            m.title,
+            m.release_date
+    FROM
+            Movie m
+    WHERE
+            ( m.genre = 'Sci-Fi' OR m.awards LIKE '%Oscar%' )
+    ORDER BY
+            m.release_date DESC
+
+
+
+**6.4 --- print(a+c)**
+
+    SELECT
+            a.name as actors_name,
+            cas.role
+    FROM
+            Actor a
+            JOIN Cast cas ON (a.cast = cas.id)
+    WHERE
+            a.age >= 45
+            AND a.age <= 69
+
+**6.5 --- print(c+m)** 
+> `... or  print(m+c)`
+
+    SELECT
+            cas.role,
+            m.title,
+            m.release_date,
+            m.director
+    FROM
+            Cast cas
+            JOIN Movie m ON (cas.movie = m.id)
+    WHERE
+            ( m.genre = 'Sci-Fi' OR m.awards LIKE '%Oscar%' )
+            AND m.director LIKE '%Coppola%'
+    ORDER BY
+            m.release_date,
+            m.director
+---
+
+### 7 - You can add or delete attributes directly in objects:
+* a(gender=Field)
+* m.delete('director')
+
+---
+
+### 8 - Defining relationship on separate objects:
+```
+a = Select...
+c = Select...
+m = Select...
+```
+`a + c => ERROR: "No relationship found between Actor and Cast"`
+
+8.1 - But...
+
+    a( cast=ForeignKey('Cast') )
+    c(id=PrimaryKey)
+
+**a + c => Ok!**
+
+8.2
+
+    c( movie=ForeignKey('Movie') )
+    m(id=PrimaryKey)
+
+> **c + m => Ok!**
+>> **m + c => Ok!**
+
+
+---
+
+### 9 - Comparing objects
+
+9.1
+```
+        a1 = Select.parse('''
+                SELECT gender, max(age) FROM Actor act
+                WHERE act.age <= 69 AND act.age >= 45
+                GROUP BY gender
+            ''')[0]
+
+        a2 = Select('Actor',
+            age=Between(45, 69), gender=GroupBy,
+            gender=[GroupBy, Field]
+        )       
+```
+> **a1 == a2 # --- True!**
+
+
+
+9.2
+```
+    m1 = Select.parse("""
+        SELECT title, release_date FROM Movie m ORDER BY release_date 
+        WHERE m.genre = 'Sci-Fi' AND m.awards LIKE '%Oscar%'
+    """)[0]
+
+    m2 = Select.parse("""
+        SELECT release_date, title
+        FROM Movie m
+        WHERE m.awards LIKE '%Oscar%' AND m.genre = 'Sci-Fi'
+        ORDER BY release_date 
+    """)[0]
+```
+
+**m1 == m2  #  --- True!**
+
+
+9.3
+```
+best_movies = SubSelect(
+    Review=Table('role'),
+    rate=[GroupBy, Having.avg(Where.gt(4.5))]
+)
+m1 = Select(
+    Movie=Table('title,release_date),
+    id=best_movies
+)
+
+sql = "SELECT rev.role FROM Review rev GROUP BY rev.rate HAVING Avg(rev.rate) > 4.5"
+m2 = Select(
+    'Movie', release_date=Field, title=Field,
+    id=Where(f"IN ({sql})")
+)
+```
+**m1 == m2 # --- True!**
+
+---
+---
+

sql_blocks-0.0.1/README.md

@@ -0,0 +1,281 @@
+# SQL_Blocks
+
+### 1 - You can assemble a simple object that will then be converted into an SQL command:
+
+> a = Select('Actor') # --> SELECT * FROM Actor act
+
+_Note that an alias "act" has been added._
+
+You can specify your own alias:  `a = Select('Actor a')`
+
+---
+### 2 - You can also add a field, like this...
+
+* a = Select('Actor a', **name=Field**)
+
+* Here are another ways to add a field:
+    - Select('Actor a', name=Distinct )
+
+    - Select('Actor a', name=NamedField('actors_name'))
+
+    - Select(
+        'Actor a', 
+        name=NamedField('actors_name'), Distinct
+    )
+
+---
+
+### 3 - To set conditions, use **Where**:
+* For example, `a = Select(... age=Where.gt(45) )`
+
+    Some possible conditions:
+    * field=Where.eq(value) - ...the field is EQUAL to the value;
+    * field=Where.gt(value) - ...the field is GREATER than the value;
+    * field=Where.lt(value) - ...the field is LESS than the value;
+
+    3.1 -- If you want to filter the field on a range of values:
+    
+    `a = Select( 'Actor a', age=Between(45, 69) )`
+
+    3.2 -- Sub-queries:
+
+```
+query = Select('Movie m', title=Field,
+    id=SubSelect(
+        'Review r',
+        rate=Where.gt(4.5),
+        movie_id=Distinct
+    )
+)
+```
+
+**>> print(query)** 
+
+        SELECT
+            m.title
+        FROM
+            Movie m
+        WHERE
+            m.id IN (
+                SELECT DISTINCT r.movie
+                FROM Review r WHERE r.rate > 4.5
+            )
+    
+3.3 -- Optional conditions:
+```
+    OR=Options(
+        genre=Where.eq("Sci-Fi"),
+        awards=Where.like("Oscar")
+    )
+```
+> Could be AND=Options(...)
+
+---
+### 4 - A field can be two things at the same time:
+
+* m = Select('Movie m' release_date=[Field, OrderBy])
+    - This means that the field will appear in the results and also that the query will be ordered by that field.
+* Applying **GROUP BY** to item 3.2, it would look like this:
+    ```    
+    SubSelect(
+        'Review r', movie=[GroupBy, Distinct],
+        rate=Having.avg(Where.gt(4.5))
+    )
+    ```
+---
+### 5 - Relationships:
+```
+    query = Select('Actor a', name=Field,
+        cast=Select('Cast c', id=PrimaryKey)
+    )
+```
+**>> print(query)**    
+```
+SELECT
+    a.name
+FROM
+    Actor a
+    JOIN Cast c ON (a.cast = c.id)    
+```
+
+---
+### 6 - The reverse process (parse):
+```
+text = """
+        SELECT
+                cas.role,
+                m.title,
+                m.release_date,
+                a.name as actors_name
+        FROM
+                Actor a
+                LEFT JOIN Cast cas ON (a.cast = cas.id)
+                LEFT JOIN Movie m ON (cas.movie = m.id)
+        WHERE
+                (
+                    m.genre = 'Sci-Fi'
+                    OR
+                    m.awards LIKE '%Oscar%'
+                )
+                AND a.age <= 69 AND a.age >= 45
+        ORDER BY
+                m.release_date DESC
+"""
+```
+
+`a, c, m = Select.parse(text)`
+
+**6.1  --- print(a)**
+```
+    SELECT
+            a.name as actors_name
+    FROM
+            Actor a
+    WHERE
+            a.age <= 69
+            AND a.age >= 45
+```
+
+**6.2 --- print(c)**
+
+    SELECT
+            c.role
+    FROM
+            Cast c
+
+**6.3 --- print(m)**
+
+    SELECT
+            m.title,
+            m.release_date
+    FROM
+            Movie m
+    WHERE
+            ( m.genre = 'Sci-Fi' OR m.awards LIKE '%Oscar%' )
+    ORDER BY
+            m.release_date DESC
+
+
+
+**6.4 --- print(a+c)**
+
+    SELECT
+            a.name as actors_name,
+            cas.role
+    FROM
+            Actor a
+            JOIN Cast cas ON (a.cast = cas.id)
+    WHERE
+            a.age >= 45
+            AND a.age <= 69
+
+**6.5 --- print(c+m)** 
+> `... or  print(m+c)`
+
+    SELECT
+            cas.role,
+            m.title,
+            m.release_date,
+            m.director
+    FROM
+            Cast cas
+            JOIN Movie m ON (cas.movie = m.id)
+    WHERE
+            ( m.genre = 'Sci-Fi' OR m.awards LIKE '%Oscar%' )
+            AND m.director LIKE '%Coppola%'
+    ORDER BY
+            m.release_date,
+            m.director
+---
+
+### 7 - You can add or delete attributes directly in objects:
+* a(gender=Field)
+* m.delete('director')
+
+---
+
+### 8 - Defining relationship on separate objects:
+```
+a = Select...
+c = Select...
+m = Select...
+```
+`a + c => ERROR: "No relationship found between Actor and Cast"`
+
+8.1 - But...
+
+    a( cast=ForeignKey('Cast') )
+    c(id=PrimaryKey)
+
+**a + c => Ok!**
+
+8.2
+
+    c( movie=ForeignKey('Movie') )
+    m(id=PrimaryKey)
+
+> **c + m => Ok!**
+>> **m + c => Ok!**
+
+
+---
+
+### 9 - Comparing objects
+
+9.1
+```
+        a1 = Select.parse('''
+                SELECT gender, max(age) FROM Actor act
+                WHERE act.age <= 69 AND act.age >= 45
+                GROUP BY gender
+            ''')[0]
+
+        a2 = Select('Actor',
+            age=Between(45, 69), gender=GroupBy,
+            gender=[GroupBy, Field]
+        )       
+```
+> **a1 == a2 # --- True!**
+
+
+
+9.2
+```
+    m1 = Select.parse("""
+        SELECT title, release_date FROM Movie m ORDER BY release_date 
+        WHERE m.genre = 'Sci-Fi' AND m.awards LIKE '%Oscar%'
+    """)[0]
+
+    m2 = Select.parse("""
+        SELECT release_date, title
+        FROM Movie m
+        WHERE m.awards LIKE '%Oscar%' AND m.genre = 'Sci-Fi'
+        ORDER BY release_date 
+    """)[0]
+```
+
+**m1 == m2  #  --- True!**
+
+
+9.3
+```
+best_movies = SubSelect(
+    Review=Table('role'),
+    rate=[GroupBy, Having.avg(Where.gt(4.5))]
+)
+m1 = Select(
+    Movie=Table('title,release_date),
+    id=best_movies
+)
+
+sql = "SELECT rev.role FROM Review rev GROUP BY rev.rate HAVING Avg(rev.rate) > 4.5"
+m2 = Select(
+    'Movie', release_date=Field, title=Field,
+    id=Where(f"IN ({sql})")
+)
+```
+**m1 == m2 # --- True!**
+
+---
+---
+

sql_blocks-0.0.1/pyproject.toml

@@ -0,0 +1,17 @@
+[project]
+name = "sql_blocks"
+version = "0.0.1"
+authors = [
+  { name="Julio Cascalles", email="julio.cascalles@outlook.com" },
+]
+description = '''Allows you to create objects for parts of SQL query commands. Also to combine these objects by joining them, adding or removing parts...'''
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://github.com/julio-cascalles/sql_blocks"

sql_blocks-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sql_blocks-0.0.1/setup.py

@@ -0,0 +1,19 @@
+from setuptools import setup
+
+
+setup(
+    name = 'sql_blocks',
+    version = '1.0.0',
+    author = 'Júlio Cascalles',
+    author_email = 'julio.cascalles@outlook.com',
+    packages = ['sql_blocks'],
+    url = 'https://github.com/julio-cascalles/sql_blocks',
+    classifiers = [
+        'Development Status :: 5 - Production/Stable',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: MIT License',
+        'Natural Language :: Portuguese (Brazilian)',
+        'Operating System :: OS Independent',
+        'Topic :: Software Development',
+    ]
+)

sql_blocks-0.0.1/sql_blocks/__init__.py

@@ -0,0 +1 @@
+from sql_blocks import *