File: cursor.rst

package info (click to toggle)
mariadb-connector-python 1.1.14-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 948 kB
  • sloc: python: 6,288; ansic: 4,973; sh: 23; makefile: 14
file content (160 lines) | stat: -rw-r--r-- 4,098 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
The cursor class
====================
.. sectionauthor:: Georg Richter <georg@mariadb.com>

.. autoclass:: mariadb.cursors.Cursor 

--------------
Cursor methods
--------------

.. automethod:: mariadb.cursors.Cursor.callproc

  Example:

  .. code-block:: python 

    >>>cursor.execute("CREATE PROCEDURE p1(IN i1 VAR  CHAR(20), OUT o2 VARCHAR(40))"
                      "BEGIN"
                      "  SELECT 'hello'"
                      "  o2:= 'test'"
                      "END")
    >>>cursor.callproc('p1', ('foo', 0))
    >>> cursor.sp_outparams
    False
    >>> cursor.fetchone()
    ('hello',)
    >>> cursor.nextset()
    True
    >>> cursor.sp_outparams
    True
    >>> cursor.fetchone()
    ('test',)

.. automethod:: mariadb.cursors.Cursor.execute

.. automethod:: mariadb.cursors.Cursor.executemany
   
  Example:

  The following example will insert 3 rows:

  .. code-block:: python 

    data= [
        (1, 'Michael', 'Widenius')
        (2, 'Diego', 'Dupin')
        (3, 'Lawrin', 'Novitsky')
    ]
    cursor.executemany("INSERT INTO colleagues VALUES (?, ?, ?)", data)

  To insert special values like NULL or a column default, you need to specify indicators:

  - INDICATOR.NULL is used for NULL values
  - INDICATOR.IGNORE is used to skip update of a column.
  - INDICATOR.DEFAULT is used for a default value (insert/update)
  - INDICATOR.ROW is used to skip update/insert of the entire row.

  .. note::

    - All values for a column must have the same data type.
    - Indicators can only be used when connecting to a MariaDB Server 10.2 or newer. MySQL servers don't support this feature.


.. automethod:: mariadb.cursors.Cursor.fetchall

.. automethod:: mariadb.cursors.Cursor.fetchmany

.. automethod:: mariadb.cursors.Cursor.fetchone

.. automethod:: mariadb.cursors.Cursor.next

.. automethod:: mariadb.cursors.Cursor.nextset

.. automethod:: mariadb.cursors.Cursor.scroll

.. automethod:: mariadb.cursors.Cursor.setinputsizes()

.. automethod:: mariadb.cursors.Cursor.setoutputsize()

-----------------
Cursor attributes
-----------------

.. autoattribute:: mariadb.cursors.Cursor.arraysize

  This read/write attribute specifies the number of rows to fetch at a time with .fetchmany(). It defaults to 1 meaning to fetch a single row at a time

.. autoattribute:: mariadb.cursors.Cursor.buffered

.. autoattribute:: mariadb.cursors.Cursor.closed

.. autoattribute:: mariadb.cursors.Cursor.connection

.. autoattribute:: mariadb.cursors.Cursor.description

  .. note::

    The 8th parameter 'field_flags' is an extension to the PEP-249 DB API standard.
    In combination with the type element field, it can be determined for example,
    whether a column is a BLOB or TEXT field:

    *Since version 1.1.0*

    The parameter table_name, original_column_name and original_table_name are an
    extension to the PEP-249 DB API standard.

  .. code-block:: python

    if cursor.description[0][1] == FIELD_TYPE.BLOB:
        if cursor.description[0][7] == FIELD_FLAG.BINARY:
            print("column is BLOB")
        else:
            print("column is TEXT") 
   

.. autoattribute:: mariadb.cursors.Cursor.lastrowid

.. autoattribute:: mariadb.cursors.Cursor.metadata

   *Since version 1.1.8*

.. autoattribute:: mariadb.cursors.Cursor.sp_outparams


.. autoattribute:: mariadb.cursors.Cursor.paramcount

   *Since version 1.1.0*

.. autoattribute:: mariadb.cursors.Cursor.rowcount

  .. note::

    For unbuffered cursors (default) the exact number of rows can only be 
    determined after all rows were fetched.

  Example:

  .. code-block:: python

    >>> cursor=conn.cursor()
    >>> cursor.execute("SELECT 1")
    >>> cursor.rowcount
    -1
    >>> rows= cursor.fetchall()
    >>> cursor.rowcount
    1
    >>> cursor=conn.cursor(buffered=True)
    >>> cursor.execute("SELECT 1")
    >>> cursor.rowcount
    1

.. autoattribute:: mariadb.cursors.Cursor.statement

.. autoattribute:: mariadb.cursors.Cursor.warnings

  .. note::

    Warnings can be retrieved by the show_warnings() method of connection class.

{% @marketo/form formId=\"4316\" %}