Skip to content
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

docs: add deprecation notices to framework guides, examples, and integrations #388

Merged
merged 22 commits into from
Apr 8, 2025
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion 010-Getting-started/010-what-is-xata.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ navTitle: What is Xata?
keywords: ['serverless', 'database', 'PostgreSQL', 'architecture']
description: An overview of Xata, the PostgreSQL database platform.
slug: concepts/serverless-data-platform
published: true
published: false
---

**Xata is a PostgreSQL database platform that optimizes for reliability, scalability, and developer experience.**
Expand Down
5 changes: 5 additions & 0 deletions 020-Connect/030-Python/100-xata-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ slug: sdk/python/overview
published: true
---

<Alert status="warning">
This feature is deprecated and no longer recommended for use in new applications. It will continue to be maintained,
but no further enhancements are planned.
</Alert>

The Python SDK is available as a [PyPI package](https://pypi.org/project/xata/). It uses type annotations and requires Python 3.8 or higher. The API reference is located at https://xata-py.readthedocs.io.

## Installation
Expand Down
7 changes: 5 additions & 2 deletions 020-Connect/099-REST/001-rest-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,12 @@ slug: rest-api
published: true
---

Xata uses HTTP-based APIs for data management and collaboration, ensuring standardization, security, and compatibility with various client apps. Adherence to RESTful principles ensures predictable and consistent API structures for evolvability without disrupting existing applications.
<Alert status="warning">
This feature is deprecated and no longer recommended for use in new applications. It will continue to be maintained,
but no further enhancements are planned.
</Alert>

> Note, Xata can support no-code or low-code data ingestion through integrations with tools like [Zapier](/docs/integrations/zapier) and [Airbyte](/docs/integrations/airbyte).
Xata uses HTTP-based APIs for data management and collaboration, ensuring standardization, security, and compatibility with various client apps. Adherence to RESTful principles ensures predictable and consistent API structures for evolvability without disrupting existing applications.

## OpenAPI specifications

Expand Down
5 changes: 5 additions & 0 deletions 030-Manage/020-dedicated-cluster.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ slug: dedicated-cluster
published: true
---

<Alert status="warning">
This feature is deprecated and no longer recommended for use in new applications. It will continue to be maintained,
but no further enhancements are planned.
</Alert>

A dedicated cluster is a Postgres cluster, which includes a writer instance and potentially multiple read replicas. You can create and allocate Xata databases and branches to this cluster. Xata databases and branches behave the same whether they are allocated to the shared or dedicated cluster.

However, a dedicated cluster provides more isolation for your workload and enables more SQL functionality, as well as the ability to install Postgres extensions. See the table for the [supported statements](/docs/postgres#supported-statements) for more detail. For these reasons, a dedicated cluster is the best choice for production workloads.
Expand Down
12 changes: 4 additions & 8 deletions 030-Manage/040-pr-based-workflow.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,15 @@ keywords: ['Vercel', 'GitHub', 'branch', 'Netlify']
description: Learn about core the Xata workflow, branching, and migrations using GitHub with Netlify or Vercel
slug: getting-started/workflow
published: true
status: beta
---

## Migrations with GitHub

<Alert status="warning">
**This feature is in Beta with known limitations**. Migrations and branching as documented below are limited in scope.
The GitHub integration does not work within a monorepo with multiple Xata databases. File attachments within records
will not get copied to generated preview branches. No data will be copied to preview branches with Postgres-enabled
databases. There is no rebase capability at present, which meants migrations should be linear and targeted towards the
main branch. GitHub Pull Requests that apply migrations cannot be reverted.
This feature is deprecated and no longer recommended for use in new applications. It will continue to be maintained,
but no further enhancements are planned.
</Alert>

## Migrations with GitHub

This guide introduces the core Xata workflow and outlines the process of configuring a project for branching and migrations using GitHub in conjunction with Netlify or Vercel. After completing the configuration, pull requests created in GitHub will generate Xata database previews that link to preview deployments in either Vercel or Netlify. After merging the pull requests, Xata will perform database migrations in sync with your code, resulting in the deployment of changes to production.

## Prerequisites
Expand Down
1 change: 0 additions & 1 deletion 030-Manage/050-usage-metrics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ keywords: ['usage', 'metrics', 'limits']
description: Get insight into your Xata usage
slug: usage-metrics
published: true
status: beta
---

Xata tracks usage of a variety of metrics at the workspace and branch levels. Pro plan workspaces include an upgraded experience that allows for more granular monitoring of your usage over time.
Expand Down
6 changes: 3 additions & 3 deletions 040-SDK/150-search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ published: true
---

<Alert status="warning">
Starting with January 10, 2025, this functionality will no longer be part of the Free plan. It will continue to be
available as documented to users on the Pro and Enterprises plans. For more details see this [blog
post](/blog/changes-free-tier).
This feature is deprecated and no longer recommended for use in new applications. It will continue to be maintained,
but no further enhancements are planned. As of January 10, 2025 this feature is only available on the [Pro and
Enterprise plans](/blog/changes-free-tier).
</Alert>

Xata natively provides text-based search for your database with the following core features:
Expand Down
7 changes: 3 additions & 4 deletions 040-SDK/151-vector-search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,12 @@ keywords: ['search', 'searching', 'vector search', 'similarity']
description: Analyze records using Xata SDK too perform calculations and get insights
slug: sdk/vector-search
published: true
status: beta
---

<Alert status="warning">
Starting with January 10, 2025, this functionality will no longer be part of the Free plan. It will continue to be
available as documented to users on the Pro and Enterprises plans. For more details see this [blog
post](/blog/changes-free-tier).
This feature is deprecated and no longer recommended for use in new applications. It will continue to be maintained,
but no further enhancements are planned. As of January 10, 2025 this feature is only available on the [Pro and
Enterprise plans](/blog/changes-free-tier). We recommend using [pgvector](/docs/postgres#extensions) instead.
</Alert>

The Xata [vector type](/docs/concepts/data-model#vector) can be combined with the `vectorSearch` API to perform similarity search on your data based on embeddings.
Expand Down
7 changes: 3 additions & 4 deletions 040-SDK/152-aggregate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,12 @@ keywords: ['aggregate', 'aggregations']
description: Leverage the power of aggregations to perform calculations of records using the Xata SDK
slug: sdk/aggregate
published: true
status: beta
---

<Alert status="warning">
Starting with January 10, 2025, this functionality will no longer be part of the Free plan. It will continue to be
available as documented to users on the Pro and Enterprises plans. For more details see this [blog
post](/blog/changes-free-tier).
This feature is deprecated and no longer recommended for use in new applications. It will continue to be maintained,
but no further enhancements are planned. As of January 10, 2025 this feature is only available on the [Pro and
Enterprise plans](/blog/changes-free-tier).
</Alert>

The `/aggregate` API allows you to use the search/analytics engine to perform aggregations on your data. Similar to the [search API](/docs/sdk/search) aggregations run in the optional Search store, which means: it is eventually consistent with the main transactional store,
Expand Down
8 changes: 1 addition & 7 deletions 040-SDK/160-ask.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,9 @@ navTitle: Ask AI
keywords: ['AI', 'artificial intelligence', 'language model']
description: Use AI to ask meaningful questions and extract valuable insights from your data
slug: sdk/ask
published: true
published: false
---

<Alert status="warning">
Starting with January 10, 2025, this functionality will no longer be part of the Free plan. It will continue to be
available as documented to users on the Pro and Enterprises plans. For more details see this [blog
post](/blog/changes-free-tier).
</Alert>

The `ask` endpoint helps you create interactive and engaging conversational interfaces, Q&A assistants, and chatbots. It provides users with swift and direct access to the information they need, eliminating the need to navigate through lengthy documentation or articles.

The endpoint leverages up-to-date information from your Xata database, such as documentation, knowledge bases, or any source of data you've configured. The `ask` endpoint uses Xata's search capabilities to find relevant information from your database, and uses this with OpenAI's ChatGPT API to interpret your question and generate natural language responses.
Expand Down
6 changes: 3 additions & 3 deletions 040-SDK/170-file-attachments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ published: true
---

<Alert status="warning">
Starting with January 10, 2025, this functionality will no longer be part of the Free plan. It will continue to be
available as documented to users on the Pro and Enterprises plans. For more details see this [blog
post](/blog/changes-free-tier).
This feature is deprecated and no longer recommended for use in new applications. It will continue to be maintained,
but no further enhancements are planned. As of January 10, 2025 this feature is only available on the [Pro and
Enterprise plans](/blog/changes-free-tier).
</Alert>

Xata offers general purpose file attachment capabilities. In order to simplify the management of large binary objects and to improve the developer experience, Xata integrates files support directly into the database itself. The aim is to offer a unified, seamless experience by exposing file support under one API, security model, and SDK. Using this approach, the [queries](/docs/sdk/get), [filters](/docs/sdk/filtering), [summaries](/docs/sdk/summarize), [aggregations](/docs/sdk/aggregate) from the SDK can also be used on the files' metadata. The metadata (file name, media type, tags) is also indexed for [search](/docs/sdk/search) in the optional Search store so it can be included in search results.
Expand Down
10 changes: 5 additions & 5 deletions 040-SDK/171-image-transformations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ published: true
---

<Alert status="warning">
Starting with January 10, 2025, this functionality will no longer be part of the Free plan. It will continue to be
available as documented to users on the Pro and Enterprises plans. For more details see this [blog
post](/blog/changes-free-tier).
This feature is deprecated and no longer recommended for use in new applications. It will continue to be maintained,
but no further enhancements are planned. As of January 10, 2025 this feature is only available on the [Pro and
Enterprise plans](/blog/changes-free-tier).
</Alert>

Xata supports transformations for images stored in Xata's `xata_file` and `xata_file_array` [column types](/docs/sdk/file-attachments).
Expand Down Expand Up @@ -455,7 +455,7 @@ const url = transformImage('https://us-east-1.storage.xata.sh/4u1fh2o6p10blbutjn
from xata.client import XataClient
xata = XataClient()

# Note that the rendered example retains the original aspect-ratio
// Note that the rendered example retains the original aspect-ratio
url = xata.files().transform_url("https://us-east-1.storage.xata.sh/4u1fh2o6p10blbutjnphcste94", {
"width": 100,
"height": 100,
Expand Down Expand Up @@ -490,7 +490,7 @@ const url = transformImage('https://us-east-1.storage.xata.sh/4u1fh2o6p10blbutjn
from xata.client import XataClient
xata = XataClient()

# Note that the rendered example retains the original aspect-ratio, but doesn't grow beyond the original size
// Note that the rendered example retains the original aspect-ratio, but doesn't grow beyond the original size
url = xata.files().transform_url("https://us-east-1.storage.xata.sh/4u1fh2o6p10blbutjnphcste94", {
"width": 250,
"height": 250,
Expand Down
2 changes: 1 addition & 1 deletion 040-SDK/190-Examples/010-gallery-app.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ navTitle: Gallery app
keywords: ['examples', 'gallery', 'file attachments', 'images', 'image transformation']
description: Create a gallery app of large binary objects that uses searchable file metadata
slug: examples/gallery-app
published: true
published: false
---

Build a gallery application using Xata's file attachment feature, which integrates file support directly into the database. You'll benefit from a unified experience for handling large binary objects, which uses searchable and queryable file metadata.
Expand Down
2 changes: 1 addition & 1 deletion 040-SDK/190-Examples/030-xmdb.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ navTitle: XMDb
keywords: ['examples']
description: Create an app that searches a movie database
slug: examples/xmdb
published: true
published: false
---

[XMDb](https://xmdb.vercel.app/) is a movie database application built with Xata. By using XMDb, users can easily search for films by entering keywords or search terms, and the application presents a list of movies ranked by relevancy. This search functionality demonstrates how Xata can manage and support extensive databases in real-world scenarios.
Expand Down
2 changes: 1 addition & 1 deletion 070-Integrations/010-airbyte.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ navTitle: Airbyte
keywords: ['airbyte', 'migrate data']
description: Use Xata with Airbyte, the integration platform that enables efficient data management from multiple sources
slug: integrations/airbyte
published: true
published: false
status: beta
---

Expand Down
2 changes: 1 addition & 1 deletion 070-Integrations/030-github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ navTitle: GitHub
keywords: ['git', 'github', 'preview', 'pull request', 'integration']
description: Use the GitHub integration to simplify database syncs with codebase, migration, and status checks
slug: integrations/github
published: true
published: false
---

<Alert status="warning">
Expand Down
5 changes: 5 additions & 0 deletions 070-Integrations/050-langchain.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ slug: integrations/langchain
published: true
---

<Alert status="warning">
This integration is deprecated and no longer recommended for use in new applications. It will continue to be
maintained, but no further enhancements are planned.
</Alert>

[LangChain](https://www.langchain.com/) is an open-source framework designed to simplify the development of applications driven by language models, especially large language models (LLMs).
Rather than just using APIs, LangChain encourages applications to link with data sources and interact dynamically with the environment. This framework brings two main advantages:

Expand Down
12 changes: 6 additions & 6 deletions 070-Integrations/060-netlify.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ navTitle: Netlify
keywords: ['build', 'platform']
description: Xata integrates with Netlify to automate migrations and support the GitHub workflow for efficient web app deployment
slug: integrations/netlify
published: true
published: false
---

[Netlify](https://https://www.netlify.com/) is a platform for hosting and deploying web applications that offers continuous deployment, build automation, and team collaboration.
Expand All @@ -21,7 +21,7 @@ When a pull request is created, a preview branch for your database is also creat

## Using Xata in your front-end application

In just a few steps, youll be up and running with this brand new workflow.
In just a few steps, you'll be up and running with this brand new workflow.

1. Install the Xata app for GitHub.
1. Install the Xata integration and plugin for Netlify.
Expand All @@ -40,11 +40,11 @@ This walkthrough assumes you have an application using Xata in a GitHub reposito
1. Add the listed Netlify integration.
1. Select the Netlify site you wish to connect.

The Xata Netlify integration configures the Xata API key and other required environment variables in your Netlify site, so you wont have to manually copy & paste settings.
The Xata Netlify integration configures the Xata API key and other required environment variables in your Netlify site, so you won't have to manually copy & paste settings.

### Install the Xata Netlify plugin

In order to select the correct Xata branch for the deployment previews, Xata uses a Netlify plugin thats easy to install:
In order to select the correct Xata branch for the deployment previews, Xata uses a Netlify plugin that's easy to install:

1. In the terminal, enter the following command:
```bash
Expand Down Expand Up @@ -82,12 +82,12 @@ The Xata GitHub app reacts to commits and pull requests just like the Netlify ap

![Preview and test the deploy](images/test-preview-deploy.png)

If you click the **View on Xata** preview link, youll see that:
If you click the **View on Xata** preview link, you'll see that:

- Xata has created a `preview-feature1` branch just for this deployment preview.
- Xata has automatically copied the data from the main branch to this preview branch.

If you click the Netlify deploy preview link, you will notice that the deploy preview is connected to the Xata preview branch and uses the new schema. This means that the reviewers can modify the data using the preview while testing and they wont affect the data in production.
If you click the Netlify deploy preview link, you will notice that the deploy preview is connected to the Xata preview branch and uses the new schema. This means that the reviewers can modify the data using the preview while testing and they won't affect the data in production.

The pull request contains the schema changes so you can tag reviewers to merge using your typical GitHub + Netlify workflow.

Expand Down
2 changes: 1 addition & 1 deletion 070-Integrations/065-oauth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ navTitle: OAuth 2
keywords: ['oauth']
description: Use OAuth 2.0 for secure authentication and authorized access
slug: integrations/oauth
published: true
published: false
status: alpha
---

Expand Down
6 changes: 3 additions & 3 deletions 070-Integrations/070-vercel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ navTitle: Vercel
keywords: ['Vercel']
description: Use Xata with Vercel, the platform that provides a serverless deployment infrastructure for web applications
slug: integrations/vercel
published: true
published: false
---

Vercel transforms application development for modern developers with efficient workflows through preview deployments.
Expand Down Expand Up @@ -49,7 +49,7 @@ Start by creating a branch for local development. The `xata branch create my_fea
git push --set-upstream origin review_stars
```

When the pull request is created, youll see a comment with the current state of your preview branch along with the Vercel comment.
When the pull request is created, you'll see a comment with the current state of your preview branch along with the Vercel comment.

![Adding a column](images/column_vercel.png)

Expand All @@ -63,4 +63,4 @@ On merge, Xata will migrate the schema changes from the preview branch into the

![Vercel preview on merge request](images/vercel-preview-merge.png)

Without any changes to your current workflow, youve added in an isolated database branch for each preview deployment.
Without any changes to your current workflow, you've added in an isolated database branch for each preview deployment.
2 changes: 1 addition & 1 deletion 070-Integrations/090-zapier.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ navTitle: Zapier
keywords: ['zapier', 'data migration']
description: Use Xata with Zapier, an online automation tool that enables connection between different web apps and automates workflows
slug: integrations/zapier
published: true
published: false
---

Xata's [Zapier Integration](https://zapier.com/apps/xata/integrations) moves data from other apps you use every day into Xata, no code required.
Expand Down
8 changes: 0 additions & 8 deletions 100-Appendix/020-pricing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,14 +74,6 @@ All Xata plans, irrespective of their pricing, include the following features:

- **High availability (HA):** Consistent service access with minimal interruptions or downtime.

- **Elasticsearch integration:** Integrates efficient and responsive full-text search capabilities within your projects. Our search engine uses Elasticsearch, which makes searches easy because it replicates all the data from our database. You get 15 GB of space initially, but can add more depending on what you need.

- **File attachments:** Xata uses S3 and Cloudflare's CDN for storing and delivering files. Your files are stored safely and you can access them quickly when you need them. Starting storage is 2 GB, but you can add more or customize it per your needs.

- **Image transformations:** You can do 10k image transformations from the start and add more as needed.

- **AI questions:** Xata offers an option for integrating with OpenAI and ChatGPT, allowing you to ask up to 250 AI-powered questions per workspace. If you want to ask more questions, you can add more with the Pro or Enterprise plans.

- **Backups:** Xata provides assisted backups for all plans. Free plan users can request data restoration from a daily backup through our support team. Pro and Enterprise plans include support-assisted backups with PITR.

- **Support:** Depending on your plan, you get different levels of support, starting from community support to dedicated support.
Expand Down
Loading