#########
Quickbase
#########

Overview
========

Quickbase is a workflow automation and data warehousing tool. This class allows you to interact
with select functions of the the `Quickbase API <https://developer.quickbase.com/>`__ .

This Parsons connector provides methods to fetch lists of available tables in Quickbase, and to
query those tables using `Quickbase API Components Query`_.

.. admonition:: Authentication

   A user token and app ID are required to instantiate the :class:`~parsons.quickbase.quickbase.Quickbase` class.
   For details, see the `Quickbase API User Tokens Documentation <https://help.quickbase.com/docs/user-tokens>`__.

Quickstart
==========

To instantiate the :class:`~parsons.quickbase.quickbase.Quickbase` class, you can either store your credentials as environment
variables (``QUICKBASE_HOSTNAME`` and ``QUICKBASE_USER_TOKEN``) or pass them in as arguments.

.. code-block:: python
   :caption: Use API credentials via environmental variables

   from parsons import Quickbase
   qb = Quickbase()

.. code-block:: python
   :caption: Pass API credentials as arguments

   from parsons import Quickbase
   qb = Quickbase(hostname='my_hostname', user_token='my_token')

.. code-block:: python
   :caption: Get all tables available from a Quickbase app

   qb.get_app_tables(app_id='my_app_id')

.. code-block:: python
   :caption: Get all data from a given table

   qb.query_records(table_from='my_table_id')

API
====

.. autoclass:: parsons.quickbase.quickbase.Quickbase
   :inherited-members:
   :members:

.. _Quickbase API Components Query: https://help.quickbase.com/docs/components-of-a-query