Changes in readme

This commit is contained in:
2014-11-25 12:43:38 +01:00
parent b48565f2de
commit 1c8a307259
2 changed files with 7 additions and 56 deletions

View File

@@ -10,22 +10,20 @@ Is a library that you can use to build sql queries if your are accustomed 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
---------------
.. code-block:: python
from sqlbuilder import SQLModel, Queryset, Q
from sqlbuilder import SQLModel, Queryset, Q, F
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")
@@ -35,14 +33,15 @@ Using it
sql.group_by("family")
qs = Queryset("users")\
sql = 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
str(sql) will result an string with the sql generated

View File

@@ -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