https://github.com/weaviate/typescript-embedded
An embedded Weaviate database with TypeScript client interface
https://github.com/weaviate/typescript-embedded
embedded-database typescript vector-search weaviate
Last synced: 6 months ago
JSON representation
An embedded Weaviate database with TypeScript client interface
- Host: GitHub
- URL: https://github.com/weaviate/typescript-embedded
- Owner: weaviate
- License: bsd-3-clause
- Created: 2023-04-21T16:21:55.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-26T15:43:38.000Z (over 1 year ago)
- Last Synced: 2025-03-25T13:11:21.460Z (7 months ago)
- Topics: embedded-database, typescript, vector-search, weaviate
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/weaviate-ts-embedded
- Size: 255 KB
- Stars: 11
- Watchers: 9
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Weaviate TypeScript EmbeddedDB 
An embedded Weaviate database with TypeScript client interface, available for Linux and Mac
## Documentation
- [Documentation](https://weaviate.io/developers/weaviate/installation/embedded).
## Examples
### With default options
Defaults:
- Host: `127.0.0.1`
- Port: `6666`
- Weaviate version: `latest`
```ts
import weaviate, { EmbeddedClient, EmbeddedOptions } from 'weaviate-ts-embedded';
const client: EmbeddedClient = weaviate.client(new EmbeddedOptions());
await client.embedded.start();
// use the client to interact with embedded Weaviate
client.embedded.stop();
```
### With custom options
```ts
import weaviate, { EmbeddedClient, EmbeddedOptions } from 'weaviate-ts-embedded';
const client: EmbeddedClient = weaviate.client(
new EmbeddedOptions({
port: 7878,
version: '1.18.1',
env: {
QUERY_DEFAULTS_LIMIT: 50,
DEFAULT_VECTORIZER_MODULE: 'text2vec-openai',
},
}),
// weaviate-ts-client ConnectionParams
{
scheme: 'http',
host: '127.0.0.1:7878',
}
);
await client.embedded.start();
// use the client to interact with embedded Weaviate
client.embedded.stop();
```
### With direct binary url
```ts
import weaviate, { EmbeddedClient, EmbeddedOptions } from 'weaviate-ts-embedded';
const binaryUrl = 'https://some-link-to-weaviate-binary';
const client: EmbeddedClient = weaviate.client(
new EmbeddedOptions({
binaryUrl: binaryUrl,
})
);
await client.embedded.start();
// use the client to interact with embedded Weaviate
client.embedded.stop();
```
## Support
- [Stackoverflow for questions](https://stackoverflow.com/questions/tagged/weaviate).
- [Github for issues](https://github.com/weaviate/typescript-embedded/issues).
## Contributing
- [How to Contribute](https://github.com/weaviate/typescript-embedded/blob/main/CONTRIBUTE.md).
## Build Status
[](https://github.com/weaviate/typescript-embedded/actions/workflows/.github/workflows/main.yaml)