README.md
author Mahlon E. Smith <mahlon@martini.nu>
Wed, 25 Sep 2019 16:07:09 -0700
changeset 19 d9922543b6f3
parent 17 29848143f305
permissions -rw-r--r--
Added tag v0.4.0 for changeset e18bc5021028
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5
cee945391bf2 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents: 4
diff changeset
     1
# Thingfish PostgreSQL Metastore
4
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
     2
17
29848143f305 Bye, Bitbucket.
Mahlon E. Smith <mahlon@martini.nu>
parents: 11
diff changeset
     3
  * http://code.martini.nu/thingfish-metastore-pggraph
29848143f305 Bye, Bitbucket.
Mahlon E. Smith <mahlon@martini.nu>
parents: 11
diff changeset
     4
  * https://github.com/mahlonsmith/thingfish-metastore-pggraph
29848143f305 Bye, Bitbucket.
Mahlon E. Smith <mahlon@martini.nu>
parents: 11
diff changeset
     5
  * https://hg.sr.ht/~mahlon/Thingfish-Metastore-PgGraph
29848143f305 Bye, Bitbucket.
Mahlon E. Smith <mahlon@martini.nu>
parents: 11
diff changeset
     6
4
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
     7
5
cee945391bf2 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents: 4
diff changeset
     8
## Description
4
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
     9
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    10
This is a metadata storage plugin for the Thingfish digital asset
10
8388c2d1d7af Additional cleanups for release.
Mahlon E. Smith <mahlon@laika.com>
parents: 9
diff changeset
    11
manager.  It provides persistent storage for uploaded data to
8388c2d1d7af Additional cleanups for release.
Mahlon E. Smith <mahlon@laika.com>
parents: 9
diff changeset
    12
PostgreSQL tables.
4
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    13
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    14
It is heavily based on the regular PG metastore, however it differs by
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    15
storing objects as nodes, and their relations as edges.
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    16
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    17
5
cee945391bf2 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents: 4
diff changeset
    18
## Authors
4
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    19
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    20
* Michael Granger <ged@FaerieMUD.org>
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    21
* Mahlon E. Smith <mahlon@martini.nu>
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    22
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    23
5
cee945391bf2 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents: 4
diff changeset
    24
## Installation
4
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    25
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    26
    $ gem install thingfish-metastore-pggraph
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    27
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    28
5
cee945391bf2 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents: 4
diff changeset
    29
##  Usage
4
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    30
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    31
As with Thingfish itself, this plugin uses
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    32
Configurability[https://rubygems.org/gems/configurability] to modify
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    33
default behaviors.
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    34
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    35
Here's an example configuration file that enables this plugin.
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    36
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    37
        ---
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    38
        thingfish:
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    39
          metastore: pggraph
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    40
11
b1f97f6063a3 Update for Configurability 3.x.
Mahlon E. Smith <mahlon@martini.nu>
parents: 10
diff changeset
    41
          pggraph_metastore:
b1f97f6063a3 Update for Configurability 3.x.
Mahlon E. Smith <mahlon@martini.nu>
parents: 10
diff changeset
    42
            uri: postgres://thingfish:password@db.example.com/database
4
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    43
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    44
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    45
When Thingfish starts, it will install the necessary database schema
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    46
automatically.
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    47
5
cee945391bf2 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents: 4
diff changeset
    48
## License
4
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    49
11
b1f97f6063a3 Update for Configurability 3.x.
Mahlon E. Smith <mahlon@martini.nu>
parents: 10
diff changeset
    50
Copyright (c) 2014-2017, Michael Granger and Mahlon E. Smith.
4
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    51
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    52
All rights reserved.
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    53
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    54
Redistribution and use in source and binary forms, with or without modification, are
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    55
permitted provided that the following conditions are met:
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    56
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    57
* Redistributions of source code must retain the above copyright notice, this
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    58
  list of conditions and the following disclaimer.
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    59
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    60
* Redistributions in binary form must reproduce the above copyright notice, this
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    61
  list of conditions and the following disclaimer in the documentation and/or
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    62
  other materials provided with the distribution.
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    63
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    64
* Neither the name of the authors, nor the names of its contributors may be used to
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    65
  endorse or promote products derived from this software without specific prior
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    66
  written permission.
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    67
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    68
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    69
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    70
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    71
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    72
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    73
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    74
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    75
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    76
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
174cf1b0f4a5 README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff changeset
    77
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
9
47425483883e Cleanups for gem release.
Mahlon E. Smith <mahlon@laika.com>
parents: 5
diff changeset
    78
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.