<commit_before>yotta
==========
Yotta DB is a local file based key value database, written in Node.js.

# Installation

## Module
`npm install yotta`

## Shell and CLI
`npm install yotta -g`

# Usage

## Yotta Shell

### Create a new DB
```
$ yotta mydb
mydb>
```
or
```
$ yotta
> open mydb
mydb>
```

### Exit Yotta DB shell
```
mydb> exit
> $
```

### Show all Yotta DB shell commands by hitting tab
```
$ yotta
>
close               exit                find                findFromValue       findKeys
findKeysFromValue   findfromvalue       findkeys            findkeysfromvalue   get
open                put                 quit                rebuildValueIndex   rebuildvalueindex
remove              stats               test                use                 vacuum

>
```

### Put some keys
```
mydb> put a 1
mydb> put b 2
mydb> put c 3
mydb> put d 4
mydb> put e 5
```

### Get a value from a key
```
mydb> get d
4<commit_msg>Docs update.<commit_after>yotta
==========
Yotta DB is a local file based key value database, written in Node.js.

# Installation

## Module
`npm install yotta`

## Shell and CLI
`npm install yotta -g`

# Usage

## Yotta Shell

### Create a new DB
```
$ yotta mydb
mydb>
```
or
```
$ yotta
> open mydb
mydb>
```

### Exit Yotta DB shell
```
mydb> exit
> $
```

### Show all Yotta DB shell commands by hitting tab
```
$ yotta
>
close               exit                find                findFromValue
findKeys            findKeysFromValue   findfromvalue       findkeys
findkeysfromvalue   get                 open                put
quit                rebuildValueIndex   rebuildvalueindex   remove
stats               test                use                 vacuum
version

>
```

### Put some keys
```
mydb> put a 1
mydb> put b 2
mydb> put c 3
mydb> put d 4
mydb> put e 5
```

### Get a value from a key
```
mydb> get d
4
{'fraction_non_alphanumeric': 0.10161290322580645, 'fraction_numerical': 0.0064516129032258064, 'mean_word_length': 1.8763523956723338, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 29, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 8, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1609036', 'n_tokens_mistral': 620, 'n_tokens_neox': 566, 'n_words': 221}