Get
Filter
Sort
Insert
Update
Delete
Copy
// Typings and client automatically up to date
import { getXataClient, Posts } from '../xata';
const xata = getXataClient();
 
// Fetching the posts is as easy as:
const posts: Posts[] = await xata.db.Posts.getMany();

Full-text
Target
Boost
Fuzziness
Copy
// Typings and client automatically up to date
import { getXataClient } from "./xata";
const xata = getXataClient();
 
// Search authors and posts tables for next.js
const records = await xata.search.all("next.js", {
  tables: [{ table: "authors" }, { table: "posts" }]
  prefix: "phrase",
});

List branches
Push and Pull
Copy
$ xata branches list
Name           Created at              Git branch
change_column  Apr 20, 2023, 8:20 PM   -
feature1       Apr 17, 2023, 11:58 PM  -
feature2       Apr 20, 2023, 7:41 PM   -
main           Apr 17, 2023, 11:50 PM  main (Current)

TypeScript & JavaScript SDK
Python SDK
REST API 
Copy
// Typings and client automatically up to date
import { getXataClient } from "./xata";
const xata = getXataClient();
 
// Table and column names are auto-complete by IntelliSense
const posts = await xata.db.posts.filter(
    {
      "author.name", "Monica Sarbu",
      "status": "published"
    }
  ).getMany();

Transaction API
Atomic updates
Copy
// Typings and client automatically up to date
import { getXataClient } from "./xata";
const xata = getXataClient();
 
// Run multiple pre-defined transactions
const result = await xata.transactions.run([
  { insert: { table: 'titles', record: { originalTitle: 'A new film' } } },
  { insert: { table: 'titles', record: { id: 'new-0', originalTitle: 'The squeel' }, createOnly: true } },
  { update: { table: 'titles', id: 'new-0', fields: { originalTitle: 'The sequel' }, ifVersion: 0 } },
  { update: { table: 'titles', id: 'new-1', fields: { originalTitle: 'The third' }, upsert: true } },
  { get:    { table: "titles", id: "new-0", columns: ['id', 'originalTitle']}},
  { delete: { table: 'titles', id: 'new-0' } }
]);

Aggregate API
Summarize API
Copy
// Typings and client automatically up to date
import { getXataClient } from "./xata";
const xata = getXataClient();
 
// get data for a multi-line chart, where each line represents a movie genre
// X axis - date, bucketed by calendar year
// Y axis - average rating
const results = await xata.db.titles.aggregate({
  "movieGenres": {
    topValues: {
      column: "genre",
      size: 50
      aggs: {
        "byReleaseDate": {
          dateHistogram: {
            column: "releaseDate",
            calendarInterval: "year",
          },
          aggs: {
            "avgRating": {
              average: {
                column: "rating"
              }
            }
          }
        }
      }
    }
  },
})

Ask
Vector search
Copy
// Typings and client automatically up to date
import { getXataClient } from "./xata";
const xata = getXataClient();
 
// Use the ask function to query ChatGPT with your data
const result = await xata.db.Tutorial.ask("How do a retrieve a single record?", {
  rules: [
     "Do not answer questions about pricing or the free tier. Respond that Xata has several options available, please check https://xata.io/pricing for more information.",
     "When you give an example, this example must exist exactly in the context given.",
   ],
   searchType: "keyword",
   search: {
     boosters: [
       {
         valueBooster: {
           column: "section",
           value: "guide",
           factor: 18
         }
       }
     ]
   }
})