> For the complete documentation index, see [llms.txt](https://alex-corvi.gitbook.io/tydb/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://alex-corvi.gitbook.io/tydb/getting-started.md).

# Getting Started

Installation & basic usage

## Installation

Using yarn or NPM you can install TyDB like this

```
$ npm i tydb
$ yarn add tydb
```

Now that you have the database installed, lets connect and start using it.

```typescript
import { Database, BaseModel } from "tydb";

class MyModel extends BaseModel {
    name: string = "alex";
    yearBorn: number = 1992;
}

const mydb = new Database<MyModel>({
    // database configuration
    // only the "ref" property is required
    ref: "mydb",
    model: MyModel
    // ... etc
});

/*
* Inserting a document based on the default
* values specified by the class above
*/
await mydb.insert([ MyModel.new({}) ]);

/*
* or ...
*/
await mydb.insert([ MyModel.new({ name: "john" }) ]);
await mydb.insert([ 
    MyModel.new({
        name: "john",  
    }),
    MyModel.new({
        _id: Math.random().toString(),
        name: "dina",
        yearBorn: 27
    })
]);

await mydb.delete({ filter: { name: "john" } });
```

The above example creates an in-memory-only database, so the data will not persisted and will be lost once the application is close or the instance is lost.

The following chart puts other ways to connect to a database into perspective:

![](https://3422004128-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M5x-OYpWMkttcJ8qdHj%2F-M671f5rYkuEFmVA0wP5%2F-M676op4rh2RPaqQOiV5%2Fimage.png?alt=media\&token=a6b03142-ea5e-49ba-9160-ddf6b9ddb228)