Skip to content

Commit 93f9787

Browse files
committed
update README
1 parent 9359466 commit 93f9787

File tree

1 file changed

+23
-17
lines changed

1 file changed

+23
-17
lines changed

README.rst

+23-17
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,24 @@ WSQL-SDK
88

99
The chain of tools that make work with SQL procedures easier.
1010

11+
Syntax
12+
******
13+
* *#include "<filename>"* - include the specified filename, the absolute and relative urls supported.
14+
* *#define name <value>* - specify the value, that can be used as *$name*
15+
* *#define name(arg1, ..., argN)* - the function, that can be used as *$name(a1,...aN)*
16+
* *#undef name* - undefine previously defined instruction
17+
* *#if condition expression else alternative* - conditional expressions
18+
* *SELECT ... ; -- > array* - hint, that informs about query returns more that one element
19+
* *SELECT ... ; -- > object* - hint, that informs about query returns exactly one element
20+
* *COMMENT "returns union"* - hint, to merge all objects from results sets to one
21+
* *COMMENT "<table name> (<colum name column type>,...);"* - hint, that allow to pass the list of arguments to procedure via temporary table
22+
1123
wsql-trans:
12-
--------------
24+
-----------
1325
The extensions above native SQL.
1426

1527
supports:
16-
*********
28+
#########
1729

1830
* macros
1931

@@ -56,22 +68,16 @@ Now supports python3 native and aio.
5668
The C++ under development.
5769
Required `WSQL`_.
5870

59-
Syntax
60-
******
61-
62-
*#include "<filename>"* - include the specified filename, the absolute and relative urls supported.
63-
*#define name <value>* - specify the value, that can be used as *$name*
64-
*#define name(arg1, ..., argN)* - the function, that can be used as *$name(a1,...aN)*
65-
*#undef name* - undefine previously defined instruction*
66-
*#if condition expression else alternative* - conditional expressions
71+
Hints
72+
#####
73+
* *SELECT ... ; -- > array* - hint, that informs about query returns more that one element
74+
* *SELECT ... ; -- > object* - hint, that informs about query returns exactly one element
75+
* *COMMENT "returns union"* - hint, to merge all objects from results sets to one
76+
* *COMMENT "<table name> (<colum name column type>,...);"* - hint, that allow to pass the list of arguments to procedure via temporary table
6777

68-
*SELECT ... ; -- > array* - hint, that query returns more that one element
69-
*SELECT ... ; -- > object* - hint, that query returns exactly one element
70-
*COMMENT "returns union"* - hint, that merge all objects from results sets to one
71-
*COMMENT "<table name> (<colum name column type>,...);"* - hint, that allow to pass the list to procedure via temporary table
7278

7379
SQL
74-
***
80+
###
7581
.. code-block:: sql
7682
7783
CREATE PROCEDURE table1.insert (value VARCHAR(10))
@@ -81,7 +87,7 @@ SQL
8187
END
8288
8389
Python3
84-
*******
90+
#######
8591

8692
.. code-block:: python
8793
@@ -106,4 +112,4 @@ Python3
106112
raise handle_error(exceptions, e)
107113
108114
109-
.. _`WSQL`: http://www.mysql.com/
115+
.. _`WSQL`: http://www.mysql.com/

0 commit comments

Comments
 (0)