Database

import { create } from '@orama/orama'

const db = await create({
  schema: {
    title: 'string',
    description: 'string',
    price: 'number',
    inStock: 'boolean'
  }
})

const db = await create({
  schema: {
    title: 'string',
    author: 'string',
    year: 'number'
  }
})

const db = await create({
  schema: { /* ... */ },
  language: 'spanish'
})

const db = await create({
  schema: { /* ... */ },
  sort: {
    enabled: true,
    unsortableProperties: ['description'] // Exclude from sorting
  }
})

const db = await create({
  schema: { /* ... */ },
  components: {
    tokenizer: customTokenizer,
    index: customIndex,
    documentsStore: customDocStore,
    sorter: customSorter
  }
})

import { pluginSecureProxy } from '@orama/plugin-secure-proxy'

const db = await create({
  schema: { /* ... */ },
  plugins: [
    await pluginSecureProxy({ apiKey: 'your-api-key' })
  ]
})

const db = await create({
  schema: { /* ... */ },
  id: 'my-custom-db-id'
})

console.log(db.id) // 'my-custom-db-id'

interface CreateArguments<OramaSchema, TIndex, TDocumentStore, TSorter, TPinning> {
  schema: OramaSchema
  sort?: SorterConfig
  language?: string
  components?: Components<
    Orama<OramaSchema, TIndex, TDocumentStore, TSorter, TPinning>,
    OramaSchema,
    TIndex,
    TDocumentStore,
    TSorter,
    TPinning
  >
  plugins?: OramaPlugin[]
  id?: string
}

function create<
  OramaSchema extends AnySchema,
  TIndex = IIndex<Index>,
  TDocumentStore = IDocumentsStore<DocumentsStore>,
  TSorter = ISorter<Sorter>,
  TPinning = any
>(args: CreateArguments<...>): Orama<...>

db.data = {
  index: /* Radix/AVL/Bool/Flat/BKD trees */,
  docs: /* Document storage */,
  sorting: /* Sorted indexes */,
  pinning: /* Pinned results */
}