Skip to main content

Extensions for sqlalchemy with databases

Project description

databases-query-extensions

Pagination, filter, search and sorting extensions for sqlalchey with encode/databases

Installation

pip install databases-query-extensions

Example

Construct page params

page_params = PaginationParams.construct(
      first=3, filter={"completed.is_true": ""}
  )

apply pagination and get results

  query = example.select()
  pagination = CursorPagination(database, query)
  paginated = await pagination.page(page_params)

apply filters, search, sorting or pagination and get query

    query = example.select()
    cursor_column="created_date"
    query = query_builder(query, page_params, cursor_column)

A complete query params example

{
    "first": 100,
    "after": <cursor>,
    "afterWith": <cursor>,
    "search": {
      "columns": ["col1", "col2"],
      "value": "new"
    },
    "filter": {
      "conversationType.eq": "Call"
      "conversationStatus.eq": "NoAanswer"
    },
    "sort": "createdAt",
    "order": "asc"
  }

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

databases-extensions-0.0.1.tar.gz (6.0 kB view hashes)

Uploaded Source

Built Distribution

databases_extensions-0.0.1-py3-none-any.whl (7.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page