author | Mahlon E. Smith <mahlon@laika.com> |
Mon, 14 Nov 2016 14:43:41 -0800 | |
changeset 9 | 47425483883e |
parent 5 | cee945391bf2 |
child 10 | 8388c2d1d7af |
permissions | -rw-r--r-- |
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 |
|
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
3 |
* http://bitbucket.org/mahlon/thingfish-metastore-pggraph |
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
4 |
|
5
cee945391bf2
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
4
diff
changeset
|
5 |
## Description |
4
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
6 |
|
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
7 |
This is a metadata storage plugin for the Thingfish digital asset |
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
8 |
manager. It provides persistent storage for uploaded data to a |
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
9 |
PostgreSQL table. |
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
10 |
|
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
11 |
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
|
12 |
storing objects as nodes, and their relations as edges. |
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 |
|
5
cee945391bf2
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
4
diff
changeset
|
15 |
## Authors |
4
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 |
* Michael Granger <ged@FaerieMUD.org> |
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
18 |
* Mahlon E. Smith <mahlon@martini.nu> |
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 |
|
5
cee945391bf2
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
4
diff
changeset
|
21 |
## Installation |
4
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 |
$ gem install thingfish-metastore-pggraph |
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
24 |
|
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
25 |
|
5
cee945391bf2
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
4
diff
changeset
|
26 |
## Usage |
4
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 |
As with Thingfish itself, this plugin uses |
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
29 |
Configurability[https://rubygems.org/gems/configurability] to modify |
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
30 |
default behaviors. |
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
31 |
|
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
32 |
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
|
33 |
|
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 |
thingfish: |
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
36 |
metastore: pggraph |
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 |
pggraph_metastore: |
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
39 |
uri: postgres://thingfish:password@db.example.com/database |
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
40 |
|
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
41 |
|
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
42 |
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
|
43 |
automatically. |
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
44 |
|
5
cee945391bf2
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
4
diff
changeset
|
45 |
## License |
4
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
46 |
|
9 | 47 |
Copyright (c) 2014-2016, Michael Granger and Mahlon E. Smith. |
4
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
48 |
|
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
49 |
All rights reserved. |
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
50 |
|
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
51 |
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
|
52 |
permitted provided that the following conditions are met: |
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 |
* 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
|
55 |
list of conditions and the following disclaimer. |
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 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
|
58 |
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
|
59 |
other materials provided with the distribution. |
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
60 |
|
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
61 |
* 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
|
62 |
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
|
63 |
written permission. |
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
64 |
|
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
65 |
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
|
66 |
"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
|
67 |
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
|
68 |
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
|
69 |
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
70 |
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
71 |
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
|
72 |
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
|
73 |
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING |
174cf1b0f4a5
README.md edited online with Bitbucket
Mahlon Smith <mahlon@martini.nu>
parents:
diff
changeset
|
74 |
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
9 | 75 |
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |