Skip to content

Docs simplification #721

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Jun 2, 2025
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions docs/blobs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,6 @@ The CrateDB Python client library provides full access to the powerful
:ref:`blob storage capabilities <crate-reference:blob_support>` of your
CrateDB cluster.

.. rubric:: Table of contents

.. contents::
:local:

Get a blob container
====================

Expand Down
6 changes: 0 additions & 6 deletions docs/by-example/client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,6 @@ Python. This section of the documentation outlines different methods to connect
to the database cluster, as well as how to run basic inquiries to the database,
and closing the connection again.

.. rubric:: Table of Contents

.. contents::
:local:


Connect to a database
=====================

Expand Down
6 changes: 0 additions & 6 deletions docs/by-example/connection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,6 @@ The examples use an instance of ``ClientMocked`` instead of a real ``Client``
instance. This allows us to verify the examples without needing a real database
connection.

.. rubric:: Table of Contents

.. contents::
:local:


connect()
=========

Expand Down
6 changes: 0 additions & 6 deletions docs/by-example/cursor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,6 @@ behaviors of the ``crate.client.cursor.Cursor`` object.
The example code uses ``ClientMocked`` and ``set_next_response`` for
demonstration purposes, so they don't need a real database connection.

.. rubric:: Table of Contents

.. contents::
:local:


Introduction
============

Expand Down
6 changes: 0 additions & 6 deletions docs/by-example/http.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,6 @@
HTTP client
===========

.. rubric:: Table of Contents

.. contents::
:local:


Introduction
============

Expand Down
6 changes: 0 additions & 6 deletions docs/by-example/https.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,6 @@ HTTPS connection support
This documentation section outlines different options to connect to CrateDB
using SSL/TLS.

.. rubric:: Table of Contents

.. contents::
:local:


Introduction
============

Expand Down
4 changes: 0 additions & 4 deletions docs/by-example/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@
By example
##########

This part of the documentation enumerates different kinds of examples how to
use the CrateDB Python DBAPI HTTP client for standards-based database
conversations, and the proprietary BLOB interfaces.

The examples in this section are all about CrateDB's `Python DB API`_ interface,
the plain HTTP API interface, and a convenience interface for working with
:ref:`blob tables <crate-reference:blob_support>`. It details attributes,
Expand Down
5 changes: 0 additions & 5 deletions docs/connect.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,6 @@ Connect to CrateDB
Supplementary information about the CrateDB Database API client can be found
in the :ref:`data types appendix <data-types-db-api>`.

.. rubric:: Table of contents

.. contents::
:local:

.. _single-node:

Connect to a single node
Expand Down
5 changes: 0 additions & 5 deletions docs/data-types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,6 @@ Data types

The data types of the :ref:`CrateDB DBAPI database API client <connect>`.

.. rubric:: Table of contents

.. contents::
:local:

.. _data-types-db-api:

Database API client
Expand Down
5 changes: 0 additions & 5 deletions docs/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,6 @@ Getting started
Learn how to install and get started with the Python client library for
`CrateDB`_.

.. rubric:: Table of contents

.. contents::
:local:

Install
=======

Expand Down
21 changes: 0 additions & 21 deletions docs/index-all.rst

This file was deleted.

61 changes: 7 additions & 54 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@
CrateDB Python Client
#####################

.. rubric:: Table of contents

.. contents::
:local:
:depth: 1


************
Introduction
Expand Down Expand Up @@ -64,7 +58,7 @@ Connect to CrateDB instance running on ``localhost``.
from pprint import pp

query = "SELECT country, mountain, coordinates, height FROM sys.summits ORDER BY country;"

with client.connect("localhost:4200", username="crate") as connection:
cursor = connection.cursor()
cursor.execute(query)
Expand All @@ -90,17 +84,12 @@ The DB API driver supports :ref:`CrateDB's data types
<crate-reference:data-types>` to different degrees. For more information,
please consult the :ref:`data-types` documentation page.

.. toctree::
:maxdepth: 2

data-types


Migration Notes
===============

The :ref:`CrateDB dialect <sqlalchemy-cratedb:index>` for `SQLAlchemy`_ is provided
by the `sqlalchemy-cratedb`_ package.
The :ref:`CrateDB dialect <sqlalchemy-cratedb:index>` for `SQLAlchemy`_ is
provided by the `sqlalchemy-cratedb`_ package.

If you are migrating from previous versions of ``crate[sqlalchemy]<1.0.0``, you
will find that the newer releases ``crate>=1.0.0`` no longer include the
Expand Down Expand Up @@ -133,53 +122,17 @@ Examples
by-example/index


*******************
Project information
*******************
. SEEALSO::

Resources
=========
- `Source code <https://github.com/crate/crate-python>`_
- `Documentation <https://crate.io/docs/python/>`_
- `Python Package Index (PyPI) <https://pypi.org/project/crate/>`_
The CrateDB Python client library is an open source project and is `managed
on GitHub`_. Contributions, feedback, or patches are highly welcome!

Contributions
=============
The CrateDB Python client library is an open source project, and is `managed on
GitHub`_.
Every kind of contribution, feedback, or patch, is much welcome. `Create an
issue`_ or submit a patch if you think we should include a new feature, or to
report or fix a bug.

Development
===========
In order to setup a development environment on your workstation, please head
over to the `development sandbox`_ documentation. When you see the software
tests succeed, you should be ready to start hacking.

Page index
==========
The full index for all documentation pages can be inspected at :ref:`index-all`.

License
=======
The project is licensed under the terms of the Apache 2.0 license, like
`CrateDB itself <CrateDB source_>`_, see `LICENSE`_.


.. _Apache Superset: https://github.com/apache/superset
.. _Crash CLI: https://crate.io/docs/crate/crash/
.. _CrateDB: https://crate.io/products/cratedb
.. _CrateDB Cloud: https://console.cratedb.cloud/
.. _CrateDB source: https://github.com/crate/crate
.. _Create an issue: https://github.com/crate/crate-python/issues
.. _Crash CLI: https://crate.io/docs/crate/crash/
.. _Dask: https://en.wikipedia.org/wiki/Dask_(software)
.. _development sandbox: https://github.com/crate/crate-python/blob/main/DEVELOP.rst
.. _cratedb-examples repository: https://github.com/crate/cratedb-examples
.. _FIWARE QuantumLeap data historian: https://github.com/orchestracities/ngsi-timeseries-api
.. _GeoJSON: https://geojson.org/
.. _GeoJSON geometry objects: https://tools.ietf.org/html/rfc7946#section-3.1
.. _LICENSE: https://github.com/crate/crate-python/blob/main/LICENSE
.. _managed on GitHub: https://github.com/crate/crate-python
.. _migrate to sqlalchemy-cratedb: https://cratedb.com/docs/sqlalchemy-cratedb/migrate-from-crate-client.html
.. _pandas: https://en.wikipedia.org/wiki/Pandas_(software)
Expand Down
5 changes: 0 additions & 5 deletions docs/query.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,6 @@ Query CrateDB
Supplementary information about the CrateDB Database API client can be found
in the :ref:`data types appendix <data-types-db-api>`.

.. rubric:: Table of contents

.. contents::
:local:

.. _cursor:

Using a cursor
Expand Down
Loading