github.com/willyham/dosa@v2.3.1-0.20171024181418-1e446d37ee71+incompatible/doc.go (about)

     1  // Copyright (c) 2017 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  // Package dosa is the DOSA - Declarative Object Storage Abstraction.
    22  //
    23  // Abstract
    24  //
    25  // :warning: DOSA is BETA software. It is not recommended for production use.
    26  // We will announce when it's ready.
    27  //
    28  //
    29  // DOSA (https://github.com/uber-go/dosa/wiki) is a storage framework that
    30  // provides a
    31  // declarative object storage abstraction for applications in Golang
    32  // and (eventually) Java. DOSA is designed to relieve common headaches developers
    33  // face while building stateful, database-dependent services.
    34  //
    35  //
    36  // If you'd like to start by writing a small DOSA-enabled program, check out
    37  // the getting started guide (https://github.com/uber-go/dosa/wiki/Getting-Started-Guide).
    38  //
    39  // Overview
    40  //
    41  // DOSA is a storage library that supports:
    42  //
    43  // • methods to store and retrieve go structs
    44  //
    45  // • struct annotations to describe queries against data
    46  //
    47  // • tools to create and/or migrate database schemas
    48  //
    49  // • implementations that serialize requests to remote stateless servers
    50  //
    51  // Annotations
    52  //
    53  // This project is released under the MIT License (LICENSE.txt).
    54  //
    55  //
    56  package dosa