Changes in readme
This commit is contained in:
15
README.rst
15
README.rst
@@ -10,22 +10,20 @@ Is a library that you can use to build sql queries if your are accustomed to use
|
|||||||
How to use
|
How to use
|
||||||
----------
|
----------
|
||||||
|
|
||||||
There are 3 main objects Q, QuerySet and SQLModel.
|
There are 4 main objects Q, F, QuerySet and SQLModel.
|
||||||
|
|
||||||
Using it
|
Using it
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
.. code-block:: python
|
.. code-block:: python
|
||||||
|
|
||||||
from sqlbuilder import SQLModel, Queryset, Q
|
from sqlbuilder import SQLModel, Queryset, Q, F
|
||||||
|
|
||||||
class Client(SQLModel):
|
class Client(SQLModel):
|
||||||
table = "clients"
|
table = "clients"
|
||||||
|
|
||||||
|
|
||||||
Client.objects.filter(name="Jhon").exclude(lastname="Doe").group_by("family")
|
Client.objects.filter(name="Jhon").exclude(lastname="Doe").group_by("family")
|
||||||
|
|
||||||
|
|
||||||
.. code-block:: python
|
|
||||||
|
|
||||||
sql = Queryset("clients").filter(name="Jhon").exclude(lastname="Doe").group_by("family")
|
sql = Queryset("clients").filter(name="Jhon").exclude(lastname="Doe").group_by("family")
|
||||||
|
|
||||||
@@ -35,14 +33,15 @@ Using it
|
|||||||
sql.group_by("family")
|
sql.group_by("family")
|
||||||
|
|
||||||
|
|
||||||
qs = Queryset("users")\
|
sql = Queryset("users")\
|
||||||
.filter(nombre="jose")\
|
.filter(nombre="jose")\
|
||||||
.order_by( "nombre", "-fecha")\
|
.order_by( "nombre", "-fecha")\
|
||||||
.filter(fecha__lte=F("now()"))[:10]
|
.filter(fecha__lte=F("now()"))[:10]
|
||||||
|
|
||||||
|
|
||||||
"SELECT * FROM users WHERE ((nombre='jose') AND (fecha<=now())) ORDER BY nombre, fecha DESC LIMIT 10"
|
"SELECT * FROM users WHERE ((nombre='jose') AND (fecha<=now())) ORDER BY nombre, fecha DESC LIMIT 10"
|
||||||
|
|
||||||
|
|
||||||
str(sql) will result an string with the sql generated
|
str(sql) will result an string with the sql generated
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
48
README.txt
48
README.txt
@@ -1,48 +0,0 @@
|
|||||||
SQL Query Builder based on django ORM
|
|
||||||
=====================================
|
|
||||||
|
|
||||||
What's that?
|
|
||||||
-----------
|
|
||||||
|
|
||||||
Is a library that you can use to build sql queries if your are accustomed to use Django ORM
|
|
||||||
|
|
||||||
|
|
||||||
How to use
|
|
||||||
----------
|
|
||||||
|
|
||||||
There are 3 main objects Q, QuerySet and SQLModel.
|
|
||||||
|
|
||||||
Using it
|
|
||||||
---------------
|
|
||||||
.. code-block:: python
|
|
||||||
|
|
||||||
from sqlbuilder import SQLModel, Queryset, Q
|
|
||||||
|
|
||||||
class Client(SQLModel):
|
|
||||||
table = "clients"
|
|
||||||
|
|
||||||
|
|
||||||
Client.objects.filter(name="Jhon").exclude(lastname="Doe").group_by("family")
|
|
||||||
|
|
||||||
|
|
||||||
.. code-block:: python
|
|
||||||
|
|
||||||
sql = Queryset("clients").filter(name="Jhon").exclude(lastname="Doe").group_by("family")
|
|
||||||
|
|
||||||
|
|
||||||
sql = Client.objects.filter(Q(name="John") & ~Q(lastname="Doe"))
|
|
||||||
|
|
||||||
sql.group_by("family")
|
|
||||||
|
|
||||||
|
|
||||||
qs = Queryset("users")\
|
|
||||||
.filter(nombre="jose")\
|
|
||||||
.order_by( "nombre", "-fecha")\
|
|
||||||
.filter(fecha__lte=F("now()"))[:10]
|
|
||||||
|
|
||||||
"SELECT * FROM users WHERE ((nombre='jose') AND (fecha<=now())) ORDER BY nombre, fecha DESC LIMIT 10"
|
|
||||||
|
|
||||||
|
|
||||||
str(sql) will result an string with the sql generated
|
|
||||||
|
|
||||||
|
|
||||||
Reference in New Issue
Block a user