Welcome to Mindsdb python SDK documentation!
============================================

Getting Started
===============

Source code
-----------

`<https://github.com/mindsdb/mindsdb_python_sdk>`_

Installation
------------

.. code-block:: console

    pip install mindsdb_sdk

Connect
-------

.. code-block:: python

    import mindsdb_sdk

    # Connect to local server

    server = mindsdb_sdk.connect()
    server = mindsdb_sdk.connect('http://127.0.0.1:47334')

    # Connect to cloud server

    server = mindsdb_sdk.connect(email='a@b.com', password='-')
    server = mindsdb_sdk.connect('https://cloud.mindsdb.com', login='a@b.com', password='-')

    # Connect to MindsDB Pro

    server = mindsdb_sdk.connect('http://<YOUR_INSTANCE_IP>', login='a@b.com', password='-', is_managed=True)

Base usage
----------

.. code-block:: python

    # database
    databases = server.list_databases()

    database = databases[0] # Database type object

    # sql query
    query = database.query('select * from table1')
    print(query.fetch())

    # create table
    table = database.create_table('table2', query)


    # project
    project = server.get_project('proj')

    # sql query
    query = project.query('select * from database.table join model1')

    # create view
    view = project.create_view(
          'view1',
           query=query
    )

    # get view
    views = project.list_views()
    view = views[0]
    df = view.fetch()

    # get model
    models = project.list_models()
    model = models[0]

    # using model
    result_df = model.predict(df)
    result_df = model.predict(query)

    # create model
    model = project.create_model(
          'rentals_model',
          predict='price',
          query=query,
    )

    More

More examples
-------------

`<https://github.com/mindsdb/mindsdb_python_sdk/examples>`_

API documentation
=================

.. toctree::
   :maxdepth: 1
   :caption: Connection:

   connection

.. toctree::
   :maxdepth: 1
   :caption: Modules:

   server
   database

   project
   handlers

   ml_engines
   model
   tables
   views
   query
   jobs

   knowledge_bases
   skills
   agents


Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`