# About the MariaDB Jupyter Kernel

The MariaDB Jupyter Kernel is an Open-Source kernel for [Jupyter](https://jupyter.org) which enables users to run MariaDB in a [Jupyter](https://jupyter.org) notebook.

Notebooks can be run in a variety of environments, ranging from your local computer for testing purposes via [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/) to complex [Zero to JupyterHub Kubernetes systems](https://zero-to-jupyterhub.readthedocs.io/en/latest/) running in the cloud.

The [mariadb\_kernel](https://github.com/MariaDB/mariadb_kernel) project is agnostic about the complexity of your [Jupyter](https://jupyter.org) infrastructure, it can run on any of them thanks to the way [Jupyter](https://jupyter.org) designed its kernel machinery. As long as MariaDB is installed on the host running the kernel and there is MariaDB Server running somewhere, things should work out as expected.

## Motivation

We created the [mariadb\_kernel](https://github.com/MariaDB/mariadb_kernel) project with some simple goals in mind:

* Help existing MariaDB users have an alternative to the classical [mariadb command-line client](https://app.gitbook.com/s/SsmexDFPv2xG2OTyO5yV/clients-and-utilities/mariadb-client/mysql-command-line-client) based on Jupyter.
* Bring MariaDB Server to Jupyter and Python users who would like to use our Open-Source database for handling their datasets.

If you would love to be able to run SQL against MariaDB data from Jupyter notebooks or you want to run a training program and help your employees learn SQL, if you are a teacher and you’d love to use Jupyter for your SQL classes or you are a data scientist trying to quickly chart or explore your datasets, you should take a look at this project.

## Contents

### [Installation](https://mariadb.com/docs/connectors/other/mariadb-jupyter-kernel/mariadb-jupyter-kernel-installation)

* [Quick Installation Steps](https://mariadb.com/docs/connectors/other/mariadb-jupyter-kernel-installation#quick-installation-steps)
* [Complete Installation Steps](https://mariadb.com/docs/connectors/other/mariadb-jupyter-kernel-installation#complete-installation-steps)
* [Platforms Coverage](https://mariadb.com/docs/connectors/other/mariadb-jupyter-kernel-installation#platforms-coverage)

### [Configuring the kernel](https://mariadb.com/docs/connectors/other/mariadb-jupyter-kernel/configuring-the-mariadb-jupyter-kernel)

* [Config File Location](https://mariadb.com/docs/connectors/other/configuring-the-mariadb-jupyter-kernel#config-file-location)
* [Config Example](https://mariadb.com/docs/connectors/other/configuring-the-mariadb-jupyter-kernel#config-example)
* [The Full List of JSON Options](https://mariadb.com/docs/connectors/other/configuring-the-mariadb-jupyter-kernel#the-full-list-of-json-options)

### [Using the Kernel](https://mariadb.com/docs/connectors/other/mariadb-jupyter-kernel)

* [General Usage Information](https://mariadb.com/docs/connectors/other/mariadb-jupyter-kernel/using-the-kernel/general-mariadb-jupyter-kernel-usage-information)
* [SQL Autocompletion and Introspection](https://mariadb.com/docs/connectors/other/mariadb-jupyter-kernel/using-the-kernel/sql-autocompletion-and-introspection)
* [Magic Commands](https://mariadb.com/docs/connectors/other/mariadb-jupyter-kernel/using-the-kernel/mariadb-jupyter-kernel-magic-commands)
* [Restrictions and Limitations](https://mariadb.com/docs/connectors/other/mariadb-jupyter-kernel/using-the-kernel/mariadb-jupyter-kernel-restrictions-and-limitations)

### [Main Components and Architecture](https://mariadb.com/docs/connectors/other/mariadb-jupyter-kernel/the-mariadb-jupyter-kernel-main-components-and-architecture)

* [Architecture](https://mariadb.com/docs/connectors/other/the-mariadb-jupyter-kernel-main-components-and-architecture#architecture)
* [Components](https://mariadb.com/docs/connectors/other/the-mariadb-jupyter-kernel-main-components-and-architecture#components)
  * [MariaDBKernel](https://mariadb.com/docs/connectors/other/the-mariadb-jupyter-kernel-main-components-and-architecture#mariadbkernel)
  * [ClientConfig](https://mariadb.com/docs/connectors/other/the-mariadb-jupyter-kernel-main-components-and-architecture#clientconfig)
  * [MariaDBClient](https://mariadb.com/docs/connectors/other/the-mariadb-jupyter-kernel-main-components-and-architecture#mariadbclient)
  * [MariaDBServer](https://mariadb.com/docs/connectors/other/the-mariadb-jupyter-kernel-main-components-and-architecture#mariadbserver)
  * [CodeParser](https://mariadb.com/docs/connectors/other/the-mariadb-jupyter-kernel-main-components-and-architecture#codeparser)
  * [MagicFactory](https://mariadb.com/docs/connectors/other/the-mariadb-jupyter-kernel-main-components-and-architecture#magicfactory)
  * [MariaMagic](https://mariadb.com/docs/connectors/other/the-mariadb-jupyter-kernel-main-components-and-architecture#mariamagic)
  * [LineMagic](https://mariadb.com/docs/connectors/other/the-mariadb-jupyter-kernel-main-components-and-architecture#linemagic)
  * [CellMagic](https://mariadb.com/docs/connectors/other/the-mariadb-jupyter-kernel-main-components-and-architecture#cellmagic)
  * [LSMagic](https://mariadb.com/docs/connectors/other/the-mariadb-jupyter-kernel-main-components-and-architecture#lsmagic)
  * [Line](https://mariadb.com/docs/connectors/other/the-mariadb-jupyter-kernel-main-components-and-architecture#line)
  * [DF](https://mariadb.com/docs/connectors/other/the-mariadb-jupyter-kernel-main-components-and-architecture#df)
  * [Bar](https://mariadb.com/docs/connectors/other/the-mariadb-jupyter-kernel-main-components-and-architecture#bar)
  * [Pie](https://mariadb.com/docs/connectors/other/the-mariadb-jupyter-kernel-main-components-and-architecture#pie)
  * [Delimiter](https://mariadb.com/docs/connectors/other/the-mariadb-jupyter-kernel-main-components-and-architecture#delimiter)

### [Extending the Kernel](https://mariadb.com/docs/connectors/other/mariadb-jupyter-kernel/contributing-to-the-mariadb-jupyter-kernel-project)

### [Changelog](https://mariadb.com/docs/connectors/other/mariadb-jupyter-kernel/changes-in-mariadb-jupyter-kernel)

* [v0.2.2](https://mariadb.com/docs/connectors/other/changes-in-mariadb-jupyter-kernel#v020-02-november-2021)
* [v0.1.1](https://mariadb.com/docs/connectors/other/changes-in-mariadb-jupyter-kernel#v011-29-march-2021)
* [v0.1.0 First release!](https://mariadb.com/docs/connectors/other/changes-in-mariadb-jupyter-kernel#v010-11-january-2021)

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