Skip to content

Commit 718a7eb

Browse files
committed
adding database function docs
1 parent 8ef89ef commit 718a7eb

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

doc/source/index.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,9 @@ See more examples of the data structures in :ref:`pyexcel documentation<pyexcel:
196196

197197
API Reference
198198
---------------
199+
200+
**Flask-Excel** attaches **pyexcel** functions to **Request** class.
201+
199202
.. module:: flask_excel
200203

201204
.. autoclass:: ExcelRequest
@@ -319,6 +322,26 @@ Response methods
319322
:param file_type: same as :meth:`~flask_excel.make_response`
320323
:param status: same as :meth:`~flask_excel.make_response`
321324

325+
.. method:: make_response_from_a_table(session, table, file_type status=200)
326+
327+
Produce a single sheet Excel book of *file_type*
328+
329+
:param session: SQLAlchemy session
330+
:param table: a SQLAlchemy table
331+
:param file_type: same as :meth:`~flask_excel.make_response`
332+
:param status: same as :meth:`~flask_excel.make_response`
333+
334+
.. method:: make_response_from_tables(session, tables, file_type status=200)
335+
336+
Produce a multiple sheet Excel book of *file_type*. It becomes the same
337+
as :meth:`~flask_excel.make_response_from_a_table` if you pass *tables*
338+
with an array that has a single table
339+
340+
:param session: SQLAlchemy session
341+
:param tables: SQLAlchemy tables
342+
:param file_type: same as :meth:`~flask_excel.make_response`
343+
:param status: same as :meth:`~flask_excel.make_response`
344+
322345

323346
Indices and tables
324347
--------------------

0 commit comments

Comments
 (0)