github.com/jbendotnet/noms@v0.0.0-20190904222105-c43e4293ea92/README.md (about)

     1  <img src='doc/nommy_cropped_smaller.png' width='350' title='Nommy, the snacky otter'>
     2  
     3  [Use Cases](#use-cases)&nbsp; | &nbsp;[Setup](#setup)&nbsp; | &nbsp;[Status](#status)&nbsp; | &nbsp;[Documentation](./doc/intro.md)&nbsp; | &nbsp;[Contact](#contact-us)
     4  <br><br>
     5  
     6  [![Build Status](https://travis-ci.org/attic-labs/noms.svg?branch=master)](https://travis-ci.org/attic-labs/noms)
     7  [![Docker Build Status](https://img.shields.io/docker/build/noms/noms.svg)](https://hub.docker.com/r/noms/noms/)
     8  [![GoDoc](https://godoc.org/github.com/attic-labs/noms?status.svg)](https://godoc.org/github.com/attic-labs/noms)
     9  
    10  # Welcome
    11  
    12  *Noms* is a decentralized database philosophically descendant from the Git version control system.
    13  
    14  Like Git, Noms is:
    15  
    16  * **Versioned:** By default, all previous versions of the database are retained. You can trivially track how the database evolved to its current state, easily and efficiently compare any two versions, or even rewind and branch from any previous version.
    17  * **Synchronizable:** Instances of a single Noms database can be disconnected from each other for any amount of time, then later reconcile their changes efficiently and correctly.
    18  
    19  Unlike Git, Noms is a database, so it also:
    20  
    21  * Primarily **stores structured data**, not files and directories (see: [the Noms type system](https://github.com/attic-labs/noms/blob/master/doc/intro.md#types))
    22  * **Scales well** to large amounts of data and concurrent clients
    23  * Supports **atomic transactions** (a single instance of Noms is CP, but Noms is typically run in production backed by S3, in which case it is "[effectively CA](https://cloud.google.com/spanner/docs/whitepapers/SpannerAndCap.pdf)")
    24  * Supports **efficient indexes** (see: [Noms prolly-trees](https://github.com/attic-labs/noms/blob/master/doc/intro.md#prolly-trees-probabilistic-b-trees))
    25  * Features a **flexible query model** (see: [GraphQL](./go/ngql/README.md))
    26  
    27  A Noms database can reside within a file system or in the cloud:
    28  
    29  * The (built-in) [NBS](./go/nbs) `ChunkStore` implementation provides two back-ends which provide persistence for Noms databases: one for storage in a file system and one for storage in an S3 bucket.
    30  
    31  Finally, because Noms is content-addressed, it yields a very pleasant programming model.
    32  
    33  Working with Noms is ***declarative***. You don't `INSERT` new data, `UPDATE` existing data, or `DELETE` old data. You simply *declare* what the data ought to be right now. If you commit the same data twice, it will be deduplicated because of content-addressing. If you commit _almost_ the same data, only the part that is different will be written.
    34  
    35  <br>
    36  
    37  ## Use Cases
    38  
    39  #### [Decentralization](./doc/decent/about.md)
    40  
    41  Because Noms is very good at sync, it makes a decent basis for rich, collaborative, fully-decentralized applications.
    42  
    43  #### Mobile Offline-First Database
    44  
    45  Embed Noms into mobile applications, making it easier to build offline-first, fully synchronizing mobile applications.
    46  
    47  <br>
    48  
    49  ## Install
    50  
    51  1. Download the latest release:
    52   - [**Linux**](https://github.com/attic-labs/noms/releases/download/latest/linux.zip)
    53   - [**Mac OS**](https://github.com/attic-labs/noms/releases/download/latest/osx.zip)
    54  2. Unzip the directory somewhere and add it to your `$PATH`
    55  3. Verify Noms is installed correctly:
    56  
    57  ```
    58  $ noms version
    59  format version: 7.18
    60  built from <developer build>
    61  ```
    62  
    63  <br>
    64  
    65  ## Run
    66  
    67  Import some data:
    68  
    69  ```shell
    70  go install github.com/attic-labs/noms/samples/go/csv/csv-import
    71  curl 'https://data.cityofnewyork.us/api/views/kku6-nxdu/rows.csv?accessType=DOWNLOAD' > /tmp/data.csv
    72  csv-import /tmp/data.csv /tmp/noms::nycdemo
    73  ```
    74  
    75  Explore:
    76  
    77  ```shell
    78  noms show /tmp/noms::nycdemo
    79  ```
    80  
    81  Should show:
    82  
    83  ```go
    84  struct Commit {
    85    meta: struct Meta {
    86      date: "2017-09-19T19:33:01Z",
    87      inputFile: "/tmp/data.csv",
    88    },
    89    parents: set {},
    90    value: [  // 236 items
    91      struct Row {
    92        countAmericanIndian: "0",
    93        countAsianNonHispanic: "3",
    94        countBlackNonHispanic: "21",
    95        countCitizenStatusTotal: "44",
    96        countCitizenStatusUnknown: "0",
    97        countEthnicityTotal: "44",
    98  ...
    99  ```
   100  
   101  <br>
   102  
   103  ## Status
   104  
   105  Nobody is working on this right now. You shouldn't rely on it unless you're willing to take over development yourself.
   106  
   107  ### Major Open Issues
   108  
   109  These are the major things you'd probably want to fix before relying on this for most systems.
   110  
   111  * Sync performance with long commit chains (https://github.com/attic-labs/noms/issues/2233)
   112  * Migration (https://github.com/attic-labs/noms/issues/3363)
   113  * Garbage Collection (https://github.com/attic-labs/noms/issues/3374)
   114  * Query language
   115    * We started trying to hack in GraphQL but it's incomplete and maybe not the right thing. See: [ngql](./go/ngql/README.md)
   116  * [Various other smaller bugs and improvements](https://github.com/attic-labs/noms/issues?q=is%3Aissue+is%3Aopen+label%3AP0)
   117  
   118  <br>
   119  
   120  ## Learn More About Noms
   121  
   122  For the decentralized web: [The Decentralized Database](doc/decent/about.md)
   123  
   124  Learn the basics: [Technical Overview](doc/intro.md)
   125  
   126  Tour the CLI: [Command-Line Interface Tour](doc/cli-tour.md)
   127  
   128  Tour the Go API: [Go SDK Tour](doc/go-tour.md)
   129  
   130  <br>
   131  
   132  ## Contact Us
   133  
   134  Interested in using Noms? Awesome! We would be happy to work with you to help understand whether Noms is a fit for your problem. Reach out at:
   135  
   136  - [Mailing List](https://groups.google.com/forum/#!forum/nomsdb)
   137  - [Twitter](https://twitter.com/nomsdb)
   138  
   139  ## Licensing
   140  
   141  Noms is open source software, licensed by Attic Labs, Inc. under the Apache License, Version 2.0.