Skip to content

Commit

Permalink
fix: fixes migration errors
Browse files Browse the repository at this point in the history
  • Loading branch information
micheleriva committed Mar 21, 2023
1 parent f5e8254 commit c81435a
Show file tree
Hide file tree
Showing 13 changed files with 369 additions and 62 deletions.
100 changes: 50 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
![Orama. Search, everywhere.](https://raw.githubusercontent.com/OramaSearch/orama/main/misc/orama-edge-logo.png)
![Orama. Search, everywhere.](https://github.com/oramasearch/orama/blob/main/misc/oramasearch.gif?raw=true)

[![Tests](https://github.com/OramaSearch/orama/actions/workflows/ci.yml/badge.svg)](https://github.com/OramaSearch/orama/actions/workflows/ci.yml)
[![Tests](https://github.com/oramasearch/orama/actions/workflows/turbo.yml/badge.svg)](https://github.com/oramasearch/orama/actions/workflows/turbo.yml)

# Join Orama's Slack channel

If you need more info, help, or want to provide general feedback on Orama, join
the
[Orama Slack channel](https://join.slack.com/t/oramasearch/shared_invite/zt-1gzvj0mmt-yJhJ6pnrSGuwqPmPx9uO5Q)

# Installation - install via @orama/orama!
# Installation

You can install Orama using `npm`, `yarn`, `pnpm`:

Expand All @@ -30,7 +30,7 @@ Or import it directly in a browser module:
<html>
<body>
<script type="module">
import { create, search, insert } from "https://unpkg.com/@orama/orama@latest/dist/index.js";
import { create, search, insert } from 'https://unpkg.com/@orama/orama@latest/dist/index.js'
// ...
</script>
Expand All @@ -46,14 +46,14 @@ Orama is quite simple to use. The first thing to do is to create a new database
instance and set an indexing schema:

```js
import { create, insert, remove, search } from "@orama/orama";
import { create, insert, remove, search } from '@orama/orama'

const db = await create({
schema: {
author: "string",
quote: "string",
author: 'string',
quote: 'string',
},
});
})
```

If you are using Node.js without ESM, please see [build](#builds) section below on how to properly require Orama.
Expand All @@ -65,36 +65,36 @@ Once the db instance is created, you can start adding some documents:

```js
await insert(db, {
quote: "It is during our darkest moments that we must focus to see the light.",
author: "Aristotle",
});
quote: 'It is during our darkest moments that we must focus to see the light.',
author: 'Aristotle',
})

await insert(db, {
quote: "If you really look closely, most overnight successes took a long time.",
author: "Steve Jobs",
});
quote: 'If you really look closely, most overnight successes took a long time.',
author: 'Steve Jobs',
})

await insert(db, {
quote: "If you are not willing to risk the usual, you will have to settle for the ordinary.",
author: "Jim Rohn",
});
quote: 'If you are not willing to risk the usual, you will have to settle for the ordinary.',
author: 'Jim Rohn',
})

await insert(db, {
quote: "You miss 100% of the shots you don't take",
author: "Wayne Gretzky - Michael Scott",
});
author: 'Wayne Gretzky - Michael Scott',
})
```

After the data has been inserted, you can finally start to query the database.

```js
const searchResult = await search(db, {
term: "if",
properties: "*",
term: 'if',
properties: '*',
boost: {
author: 1.5 // optional: boost author field by x1.5
}
});
author: 1.5, // optional: boost author field by x1.5
},
})
```

In the case above, you will be searching for all the documents containing the
Expand Down Expand Up @@ -129,9 +129,9 @@ You can also restrict the lookup to a specific property:

```js
const searchResult = await search(db, {
term: "Michael",
properties: ["author"],
});
term: 'Michael',
properties: ['author'],
})
```

Result:
Expand All @@ -156,21 +156,21 @@ Result:
If needed, you can also delete a given document by using the `remove` method:

```js
await remove(db, "41045799-144");
await remove(db, '41045799-144')
```

Orama exposes a built-in `formatNanoseconds` function to format the elapsed time
in a human-readable format:

```js
import { formatNanoseconds } from "@orama/orama";
import { formatNanoseconds } from '@orama/orama'

const searchResult = await search(db, {
term: "if",
properties: "*",
});
term: 'if',
properties: '*',
})

console.log(`Search took ${formatNanoseconds(searchResult.elapsed)}`);
console.log(`Search took ${formatNanoseconds(searchResult.elapsed)}`)
// Search took 164μs
```

Expand All @@ -185,15 +185,15 @@ Starting with version 0.4.0 it becomes:

```js
async function main() {
const { create, insert } = await import("@orama/orama");
const { create, insert } = await import('@orama/orama')

const db = create(/* ... */);
const db = create(/* ... */)
insert(db, {
/* ... */
});
})
}

main().catch(console.error);
main().catch(console.error)
```

#### Use CJS requires
Expand Down Expand Up @@ -226,45 +226,45 @@ shipped with the default Orama installation.
Example:
```js
import { create } from "@orama/orama";
import { stemmer } from "@orama/orama/components/stemmer/it";
import { create } from '@orama/orama'
import { stemmer } from '@orama/orama/components/stemmer/it'

const db = await create({
schema: {
author: "string",
quote: "string",
author: 'string',
quote: 'string',
},
defaultLanguage: "italian",
defaultLanguage: 'italian',
components: {
tokenizer: {
stemmingFn: stemmer,
},
},
});
})
```
Example using CJS (see [using with commonJS](#using-with-commonjs) above):
```js
async function main() {
const { create } = await import("@orama/orama");
const { stemmer } = await import("@orama/orama/components/stemmer/it");
const { create } = await import('@orama/orama')
const { stemmer } = await import('@orama/orama/components/stemmer/it')

const db = await create({
schema: {
author: "string",
quote: "string",
author: 'string',
quote: 'string',
},
defaultLanguage: "italian",
defaultLanguage: 'italian',
components: {
tokenizer: {
stemmingFn: stemmer,
},
},
});
})
}

main();
main()
```
Right now, Orama supports 26 languages and stemmers out of the box:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "orama-monorepo",
"version": "1.0.0-beta.0",
"version": "1.0.0-beta.1",
"description": "Next generation full-text search engine, written in TypeScript",
"workspaces": [
"packages/*"
Expand Down
2 changes: 1 addition & 1 deletion packages/benchmarks/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "benchmarks",
"version": "1.0.0-beta.0",
"version": "1.0.0-beta.1",
"scripts": {
"run": "node ./typo-tolerant-search.js"
},
Expand Down
6 changes: 4 additions & 2 deletions packages/docs/package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
{
"name": "@orama/docs",
"version": "1.0.0-beta.0",
"version": "1.0.0-beta.1",
"description": "Documentation for Orama",
"main": "index.js",
"scripts": {
"dev": "next dev"
"dev": "next dev",
"build": "next build",
"serve": "next start"
},
"keywords": [],
"author": "",
Expand Down
Loading

0 comments on commit c81435a

Please sign in to comment.