-
Notifications
You must be signed in to change notification settings - Fork 29
/
Copy pathintroduction.html
257 lines (228 loc) · 9.64 KB
/
introduction.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link href="https://fonts.googleapis.com/css?family=Roboto+Mono" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Boogaloo" rel="stylesheet">
<link rel="apple-touch-icon" sizes="180x180" href="https://www.graphiti.dev/assets/favicons/apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="32x32" href="https://www.graphiti.dev/assets/favicons/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="16x16" href="https://www.graphiti.dev/assets/favicons/favicon-16x16.png">
<link rel="manifest" href="https://www.graphiti.dev/assets/favicons/site.webmanifest">
<link rel="mask-icon" href="https://www.graphiti.dev/assets/favicons/safari-pinned-tab.svg" color="#F86DA7">
<link rel="shortcut icon" href="https://www.graphiti.dev/assets/favicons/favicon.ico">
<meta name="msapplication-TileColor" content="#F86DA7">
<meta name="msapplication-config" content="https://www.graphiti.dev/assets/favicons/browserconfig.xml">
<meta name="theme-color" content="#F86DA7">
<title>Graphiti</title>
<meta name="description" content="Stylish Graph APIs">
<link rel="stylesheet" href="https://www.graphiti.dev/assets/main.css?ref=wh4t3v45">
<link rel="alternate" type="application/rss+xml" title="Graphiti" href="/feed.xml">
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-127904727-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-127904727-1');
</script>
<!-- javascript -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
</head>
<body>
<main class="page-content" aria-label="Content">
<div class="wrapper">
<header class="navbar navbar-inverse normal" role="banner">
<div class="container">
<div class="navbar-header">
<a href="https://www.graphiti.dev" class="navbar-brand">
<img alt="logo" src="/assets/img/logo.png">
</a>
</div>
<nav class="" role="navigation">
<ul class="nav navbar-nav nav-links">
<li>
<a class="quickstart nav-link" href="https://www.graphiti.dev/quickstart">Quickstart</a>
</li>
<li>
<a class="guides nav-link" href="https://www.graphiti.dev/guides">Guides</a>
</li>
<li>
<a class="tutorial nav-link" href="https://www.graphiti.dev/tutorial">Tutorial</a>
</li>
<li>
<a class="spraypaint nav-link" href="https://www.graphiti.dev/js">Spraypaint</a>
</li>
</ul>
<ul class="nav gh navbar-nav navbar-right visible-lg visible-md">
<li>
<span class="star">⭐</span>
<a href="https://github.com/graphiti-api/graphiti">
<img alt="github-star" style="margin-right: 65px;margin-top: -20px" src="/assets/img/gh.png">
</a>
</li>
</ul>
</nav>
</div>
</header>
<div class="container">
<h1>
Spraypaint
<small>the isomorphic, framework-agnostic Graphiti ORM</small>
</h1>
<div class="js-toc col-md-3">
<ul>
<li><a href="https://www.graphiti.dev/js/index">Home</a></li>
<li><a href="https://www.graphiti.dev/js/introduction">Introduction</a></li>
<li><a href="https://www.graphiti.dev/js/installation">Installation</a>
<ul>
<li><a href="https://www.graphiti.dev/js/installation#typescript">Typescript</a></li>
<li><a href="https://www.graphiti.dev/js/installation#defining-models">Defining Models</a></li>
<li><a href="https://www.graphiti.dev/js/installation#connecting-to-the-api">Connecting to the API</a></li>
<li><a href="https://www.graphiti.dev/js/installation#defining-attributes">Defining Attributes</a></li>
<li><a href="https://www.graphiti.dev/js/installation#defining-relationships">Defining Relationships</a></li>
</ul>
</li>
<li><a href="https://www.graphiti.dev/js/reads">Reads</a>
<ul>
<li><a href="https://www.graphiti.dev/js/reads/sorting">Sorting</a></li>
<li><a href="https://www.graphiti.dev/js/reads/pagination">Pagination</a></li>
<li><a href="https://www.graphiti.dev/js/reads/filtering">Filtering</a></li>
<li><a href="https://www.graphiti.dev/js/reads/fieldsets">Fieldsets</a></li>
<li><a href="https://www.graphiti.dev/js/reads/statistics">Statistics</a></li>
<li><a href="https://www.graphiti.dev/js/reads/includes">Includes</a></li>
<li><a href="https://www.graphiti.dev/js/reads/nested-queries">Nested Queries</a></li>
</ul>
</li>
<li><a href="https://www.graphiti.dev/js/writes">Writes</a>
<ul>
<li><a href="https://www.graphiti.dev/js/writes/validations">Validations</a></li>
<li><a href="https://www.graphiti.dev/js/writes/dirty-tracking">Dirty Tracking</a></li>
<li><a href="https://www.graphiti.dev/js/writes/nested">Nested Writes</a></li>
<li><a href="https://www.graphiti.dev/js/writes/deferred">Deferred Action</a></li>
</ul>
</li>
<li><a href="https://www.graphiti.dev/js/middleware">Middleware</a></li>
<li><a href="https://www.graphiti.dev/js/authentication">Authentication</a></li>
<li><a href="https://www.graphiti.dev/js/state-syncing">State Syncing</a></li>
<li><a href="https://www.graphiti.dev/js/ddau">Data Down, Actions Up</a></li>
<li><a href="https://www.graphiti.dev/js/extra-params">Extra params</a></li>
</ul>
</div>
<div class="col-md-8 col-md-offset-1">
<h3 id="why-spraypaint">Why Spraypaint?</h3>
<p>Contracts like JSONAPI and GraphQL treat the API like a database. When querying a
database, we have two options:</p>
<ul>
<li>Type the low-level query language directly (in the database world,
this would be hand-typing SQL).</li>
<li>Use an ORM (like Rails’s <code class="highlighter-rouge">ActiveRecord</code>, Phoenix’s <code class="highlighter-rouge">Ecto</code>, Django’s
<code class="highlighter-rouge">DjangoORM</code>, or Node’s <code class="highlighter-rouge">Sequelize</code>).</li>
</ul>
<p>While both options have pros and cons, we tend to think ORMs
have two overwhelming benefits: <strong><em>ease of use</em></strong> and <strong><em>composable queries</em></strong>.
We’ll explore both these concepts in other sections.</p>
<p>So, we want a javascript ORM for our JSONAPI “database”. Because
<code class="highlighter-rouge">ActiveRecord</code> is arguably the most well-known ORM, we’ve tried to match
its interface to make this library accessible to new users. That said,
you’ll find we’ve tried to favor <em>explicitness</em> over <em>implicitness</em> in
order to avoid common <code class="highlighter-rouge">ActiveRecord</code> pitfalls.</p>
</div>
<div class="clearfix">
<h2 id="next">
<a href="https://www.graphiti.dev/js/installation">
NEXT:
<small>Installation</small>
»
</a>
</h2>
</div>
</div>
</div>
</main>
<div class="main-footer main-footer--dark">
<div class="container">
<div class="row">
<div class="col-sm-4 menu">
<h3>Overview</h3>
<ul>
<li>
<a href="https://www.graphiti.dev/quickstart">Quickstart</a>
</li>
<li>
<a href="https://www.graphiti.dev/tutorial">Tutorial</a>
</li>
<li>
<a href="https://www.graphiti.dev/guides">Guides</a>
</li>
</ul>
</div>
<div class="col-sm-4 menu">
<h3>Contact</h3>
<ul>
<li>
<a target="_blank" href="https://join.slack.com/t/graphiti-api/shared_invite/enQtMjkyMTA3MDgxNTQzLTU5MDI4MDllNTEzOTE1Nzk0ZGJlNTcxZDYzMGY2ZTczMDY2OWZhM2RmNTU0YWNiOWZhZDhkMmU4MzQ5NzIyNWM">Slack Chat</a>
</li>
<li>
<a href="mailto:[email protected]">Email</a>
</li>
</ul>
</div>
<div class="col-sm-4 menu">
<h3>Related</h3>
<ul>
<li>
<a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
</li>
<li>
<a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
</li>
<li>
<a target="_blank" href="https://vuejs.org/">VueJS</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<script type="text/javascript">
$(function () {
var flipTabs = function() {
var isTS = true;
if (localStorage.getItem('js-lang') === 'javascript') {
isTS = false;
}
$('.code-tabs').each(function(index, el) {
if (isTS) {
console.log('hiding js');
$($(el).children()[1]).hide();
$($(el).children()[0]).show();
} else {
console.log('hiding ts');
$($(el).children()[0]).hide();
$($(el).children()[1]).show();
}
});
if (isTS) {
$('.tab.typescript').addClass('active');
$('.tab.javascript').removeClass('active');
} else {
$('.tab.typescript').removeClass('active');
$('.tab.javascript').addClass('active');
}
}
$('.tab').click(function() {
if ($(this).hasClass('typescript')) {
localStorage.setItem('js-lang', 'typescript');
} else {
localStorage.setItem('js-lang', 'javascript');
}
flipTabs();
});
flipTabs();
})
</script>
</body>
</html>