-
-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathindex.html
538 lines (376 loc) · 22.3 KB
/
index.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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
<!doctype html>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="shortcut icon" type="image/x-icon" href="/static/favicon.ico">
<link rel="stylesheet" href="/static/gen/style.css">
<link rel="stylesheet" href="/static/pygments.css">
<meta property="og:site_name" content="Creative Commons" />
<meta property="og:title" content="Data flow: from API to DB" />
<meta property="og:description" content="IntroductionThe CC Catalog project handles the flow of image metadata from the source or
provider and loads it to the database, which is then surfaced to the CC
search tool. The workflows are set up for each provider to gather
metadata about CC licensed images. These workflows are handled with the help of
Apache Airflow. Airflow is an open source tool that helps us to schedule and
monitor workflows." />
<meta property="og:url" content="/blog/entries/data-flow-API-to-DB/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://cc-og-image.vercel.app/Data flow: from API to DB.png?&md=1&fontFamily=roboto-condensed&fontSize=100px&images=https%3A%2F%2Fcc-vocabulary.netlify.app%2Flogos%2Fproducts%2Fopen_source.svg%23opensource" />
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:title" content="Data flow: from API to DB">
<meta name="twitter:description" content="IntroductionThe CC Catalog project handles the flow of image metadata from the source or
provider and loads it to the database, which is then surfaced to the CC
search tool. The workflows are set up for each provider to gather
metadata about CC licensed images. These workflows are handled with the help of
Apache Airflow. Airflow is an open source tool that helps us to schedule and
monitor workflows.">
<meta name="twitter:site" content="@creativecommons">
<meta name="twitter:creator" content="@creativecommons">
<meta name="monetization" content="$ilp.uphold.com/edR8erBDbRyq">
<script src="https://code.jquery.com/jquery-3.3.1.min.js"
integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.6/umd/popper.min.js"
integrity="sha384-wHAiFfRlMFy6i5SRaxvfOCifBUQy1xHdJ/yoi7FRNXMRBu5WHdZYu1hA6ZOblgut" crossorigin="anonymous"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.2.1/js/bootstrap.min.js"
integrity="sha384-B0UglyR+jN6CkvvICOB2joaf5I4l3gm9GU6Hc1og6Ls7i6U/mkkaduKaBhlAXv9k" crossorigin="anonymous"></script>
<script type="text/javascript" src="/static/gen/script.js"></script>
<script src="https://unpkg.com/@creativecommons/vocabulary@2020.7.2/js/vocabulary.js"></script>
<script>
const globalHeaderInstance = vocabulary.createGlobalHeader();
</script>
<title>Data flow: from API to DB — Creative Commons Open Source</title>
<body>
<!-- Header -->
<header class="container">
<nav class="navbar">
<div class="navbar-brand">
<a class="has-text-black" href="/">
<svg
class="logo margin-top-small"
xmlns="http://www.w3.org/2000/svg"
preserveAspectRatio="xMidYMid meet"
viewBox="0 0 284 46">
<use href="#opensource"></use>
</svg>
</a>
<a role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
</a>
</div>
<div class="navbar-menu">
<div class="navbar-end">
<a class="navbar-item is-active" href="/blog/entries/">
Blog
</a>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link is-arrowless " tabindex="0">
Contribute<i class="icon caret-down"></i></a>
<div class="navbar-dropdown">
<a class="navbar-item" href="/contributing-code/">Contribution Guidelines</a>
<a class="navbar-item" href="/contributing-code/projects/">Project List</a>
<a class="navbar-item" href="/contributing-code/issue-finder/">Issue Finder</a>
<a class="navbar-item" href="/contributing-code/pr-guidelines/">Pull Request Guidelines</a>
<a class="navbar-item" href="/contributing-code/github-repo-guidelines/">GitHub Repo Guidelines</a>
<a class="navbar-item" href="/contributing-code/repo-labels/">Repository Labels</a>
<a class="navbar-item" href="/contributing-code/javascript-guidelines/">JavaScript Guidelines</a>
<a class="navbar-item" href="/contributing-code/python-guidelines/">Python Guidelines</a>
<a class="navbar-item" href="/contributing-code/translation-guide/">Translation Guide</a>
<a class="navbar-item" href="/contributing-code/usability/">Usability</a>
</div>
</div>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link is-arrowless " tabindex="0">
Community<i class="icon caret-down"></i></a>
<div class="navbar-dropdown is-active">
<a class="navbar-item" href="/community/">Join the Community</a>
<a class="navbar-item" href="/community/community-team/">Community Team</a>
<a class="navbar-item" href="/community/community-team/members/">Community Team Members</a>
<a class="navbar-item" href="/community/community-team/project-roles/">Project Roles</a>
<a class="navbar-item" href="/community/community-team/community-building-roles/">Community Building Roles</a>
<a class="navbar-item" href="/community/write-a-blog-post/">Write a Blog Post</a>
<a class="navbar-item" href="/community/code-of-conduct/">Code of Conduct</a>
<a class="navbar-item" href="/community/code-of-conduct/enforcement/">Code of Conduct Enforcement</a>
</div>
</div>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link is-arrowless " tabindex="0">
Work Programs<i class="icon caret-down"></i></a>
<div class="navbar-dropdown">
<a class="navbar-item" href="/programs/">Overview</a>
<a class="navbar-item" href="/programs/project-ideas/">Project Ideas</a>
<a class="navbar-item" href="/programs/applicant-guide/">Applicant Guide</a>
<a class="navbar-item" href="/programs/contrib-guide/">Contributor Guide</a>
<a class="navbar-item" href="/programs/lead-guide/">Project Lead Guide</a>
<a class="navbar-item" href="/programs/history/">History</a>
</div>
</div>
</div>
</div>
</nav>
</header>
<!-- Breadcrumb -->
<div class="breadcrumb-container">
<nav class="container breadcrumb caption bold" aria-label="breadcrumbs">
<ul>
<!-- Extracting the slugs of URL -->
<!-- Active link -->
<!-- Forming the URL using extracted slugs -->
<li><a class="link" href="/">
Home
</a></li>
<!-- Active link -->
<!-- Forming the URL using extracted slugs -->
<li><a class="link" href="/blog/">
Blog
</a></li>
<!-- Active link -->
<!-- Forming the URL using extracted slugs -->
<li><a class="link" href="/blog/entries/">
Entries
</a></li>
<!-- Active link -->
<li class="is-active"><a aria-current="page displayed">Data flow: from API to DB</a></li>
</ul>
</nav>
</div>
<!-- Body -->
<div class="single-post">
<header class="single-post-header">
<div class="container">
<h4>CC Open Source Blog</h4>
<h2 class="title">Data flow: from API to DB</h2>
<div class="author columns is-marginless">
<header>
<figure class="image blog-image">
<img class="profile" src="https://secure.gravatar.com/avatar/7e71c293a442a2cf434bfc244bd5f184?size=200&d=mp" alt="gravatar" />
</figure>
</header>
<p class="padding-small">
by <a class="author-name" href="/blog/authors/srinidhi/">K S Srinidhi Krishna</a> on 2020-07-22
</p>
</div>
<div class="series-header">
<span>This blog is part of the series:</span>
<a href="#series">GSoC 2020: CC catalog</a>
</div>
</div>
</header>
<div class="single-post-body content container">
<h2 id="introduction">Introduction</h2><p>The CC Catalog project handles the flow of image metadata from the source or
provider and loads it to the database, which is then surfaced to the <a href="https://ccsearch.creativecommons.org/about">CC
search</a> tool. The workflows are set up for each provider to gather
metadata about CC licensed images. These workflows are handled with the help of
Apache Airflow. Airflow is an open source tool that helps us to schedule and
monitor workflows.</p>
<h2 id="airflow-intro">Airflow intro</h2><p>Apache Airflow is an open source tool that helps us to schedule tasks and
monitor workflows . It provides an easy to use UI that makes managing tasks
easy. In Airflow, the tasks we want to schedule are organised in DAGs
(Directed Acyclic Graphs). DAGs consist of a collection of tasks, and a
relationship defined among these tasks, so that they run in an organised
manner. DAGs files are standard python files that are loaded from the defined
<code>DAG_FOLDER</code> on a host. Airflow selects all the python files in the
<code>DAG_FOLDER</code> that have a DAG instance defined globally, and executes them to
create the DAG objects.</p>
<h2 id="cc-catalog-workflow">CC Catalog Workflow</h2><p>In the CC catalog, Airflow is set up inside a docker container along with other
services . The loader and provider workflows are inside the <code>dags</code> directory in
the repo <a href="https://github.com/creativecommons/cccatalog/tree/dacb48d24c6ae9b532ff108589b9326bde0d37a3/src/cc_catalog_airflow/dags">dag folder</a>. Provider workflows are set up to pull metadata
about CC licensed images from the respective providers , the data pulled is
structured into a standardised format and written into a TSV (Tab Separated
Values) file locally. These TSV files are then loaded into S3 and then finally
to PostgreSQL DB by the loader workflow.</p>
<h2 id="provider-api-workflow">Provider API workflow</h2><p>The provider workflows are usually scheduled in one of two time frequencies,
daily or monthly.</p>
<p>Providers such as Flickr or Wikimedia Commons that are filtered using the date
parameter are usually scheduled for daily jobs. These providers have a large
volume of continuously changing data, and so daily updates are required to keep
the data in sync.</p>
<p>Providers that are scheduled for monthly ingestion are ones with a relativley
low volume of data, or for which filtering by date is not possible. This means
we need to ingest the entire collection at once. Examples are museum providers
like the <a href="https://collection.sciencemuseumgroup.org.uk/">Science museum UK</a> or <a href="https://www.smk.dk/">Statens Museum for
Kunst</a>. We don’t expect museum providers to change data on a daily basis.</p>
<p>The scheduling of the DAGs by the scheduler daemons depends on a few
parameters.</p>
<ul>
<li><code>start_date</code> - it denotes the starting date from which the
task should begin running. </li>
<li><code>schedule_interval</code> - it denotes the interval between subsequent runs, it
can be specified with airflow keyword strings like “@daily”, “@weekly”,
“@monthly”, “@yearly” other than these we can also schedule the interval using
cron expression.</li>
</ul>
<p>Example: Cleveland museum is currently scheduled for a monthly crawl with a
starting date as <code>2020-01-15</code>. <a href="https://github.com/creativecommons/cccatalog/blob/dacb48d24c6ae9b532ff108589b9326bde0d37a3/src/cc_catalog_airflow/dags/cleveland_museum_workflow.py">cleveland_museum_workflow</a></p>
<h2 id="loader-workflow">Loader workflow</h2><p>The data from the provider scripts are not directly loaded into S3. Instead,
they are stored in a TSV file on the local disk, and the tsv_postgres workflow
handles loading of data to S3, and eventually PostgreSQL. The DAG starts by
calling the task to stage the oldest tsv file from the output directory of the
provider scripts to the staging directory. Next, two tasks run in parallel, one
loads the tsv file in the staging directory to S3 , while the other creates the
loading table in the PostgreSQL database. Once the data is loaded to S3 and the
loading table has been created, the data from S3 is loaded to the intermediate
loading table and then finally inserted into the image table. If loading from
S3 fails the data is loaded to PostgreSQL from the locally stored tsv file.
When the data has been successfully transferred to the image table, the
intermediate loading table is dropped and the tsv files in the staging
directory are deleted. If the copying the tsv files to S3 fails or then those
files are moved to the failure directory for future inspection.</p>
<div style="text-align:center;">
<img src="loader_workflow.png" width="1000px"/>
<p> Loader workflow </p>
</div><h2 id="acknowledgement">Acknowledgement</h2><p>I would like to thank Brent Moran for helping me write this blog post.</p>
</div>
<footer class="single-post-footer container">
<div class="category">
<h4 class="category-title">Categories</h4>
<div class="categories">
<a class="button tag" href=" /blog/categories/cc-catalog/ ">cc-catalog</a>
<a class="button tag" href=" /blog/categories/airflow/ ">airflow</a>
<a class="button tag" href=" /blog/categories/gsoc/ ">gsoc</a>
<a class="button tag" href=" /blog/categories/gsoc-2020/ ">gsoc-2020</a>
</div>
</div>
<div class="series-posts" id="series">
<h5 class="title">Posts in the GSoC 2020: CC catalog series</h5>
<ul class="posts">
<li>
<i class="icon circle-filled"></i><a href="/blog/entries/science-museum-implementation/">Science Museum provider implementation</a>
</li>
<li>
<i class="icon circle-filled"></i><a href="/blog/entries/flickr-sub-provider-retrieval/">Flickr Sub-provider Retrieval</a>
</li>
<li class="has-color-dark-slate-gray">
<i class="icon circle-filled"></i>Data flow: from API to DB
</li>
<li>
<i class="icon circle-filled"></i><a href="/blog/entries/smithsonian-unit-code-update/">Smithsonian Unit Code Update</a>
</li>
<li>
<i class="icon circle-filled"></i><a href="/blog/entries/cc-catalog-wrapping-gsoc20/">CC Catalog: wrapping up GSoC20</a>
</li>
<li>
<i class="icon circle-filled"></i><a href="/blog/entries/overview-of-the-gsoc-2020-project/">Overview of the GSoC 2020 Project</a>
</li>
</ul>
</div>
<div class="comments">
<div id="disqus_thread"></div>
<script>
var disqus_config = function() { this.page.identifier = "/blog/entries/data-flow-API-to-DB"; this.page.url = "http://opensource.creativecommons.org/blog/entries/data-flow-API-to-DB/"; };
(function() {
var d = document, s = d.createElement('script');
s.src = '//cc-open-source.disqus.com/embed.js';
s.setAttribute('data-timestamp', +new Date());
(d.head || d.body).appendChild(s);
})();
</script>
<noscript>
Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript"
rel="nofollow">comments powered by Disqus.</a>
</noscript>
</div>
</footer>
</div>
<!-- Footer -->
<footer class="main-footer">
<div class="container">
<div class="columns">
<div class="column is-one-third-tablet-only is-one-quarter-desktop">
<a href="https://creativecommons.org" class="main-logo margin-bottom-bigger">
<span class="has-text-white">
<svg
xmlns="http://www.w3.org/2000/svg"
preserveAspectRatio="xMidYMid meet"
viewBox="0 0 304 73">
<use href="#logomark"></use>
</svg>
</span>
</a>
<div>
<address class="margin-bottom-normal">Creative Commons<br />PO Box 1866, Mountain View CA 94042</address>
<a href="mailto:info@creativecommons.org" class="mail">info@creativecommons.org</a><br />
<a href="tel://+1-415-429-6753" class="phone">+1-415-429-6753</a>
</div>
<div class="margin-vertical-large">
<a href="https://www.instagram.com/creativecommons" class="social has-text-white" target="_blank"
rel="noopener">
<i class="icon margin-right-small is-size-4">instagram</i>
</a>
<a href="https://www.twitter.com/creativecommons" class="social has-text-white" target="_blank"
rel="noopener">
<i class="icon margin-right-small is-size-4">twitter</i>
</a>
<a href="https://www.facebook.com/creativecommons" class="social has-text-white" target="_blank"
rel="noopener">
<i class="icon margin-right-small is-size-4">facebook</i>
</a>
<a href="https://www.linkedin.com/company/creative-commons/" class="social has-text-white" target="_blank"
rel="noopener">
<i class="icon margin-right-small is-size-4">linkedin</i>
</a>
</div>
</div>
<div class="column is-two-third-tablet-only is-three-quarters-desktop">
<div class="columns">
<div class="column is-full">
<nav class="footer-navigation">
<ul class="menu">
<li>
<a href="/blog/entries/" class="menu-item">Blog</a>
</li>
<li>
<a href="/community/community-team/" class="menu-item">Community Team</a>
</li>
<li>
<a href="/contributing-code/projects/" class="menu-item">Project List</a>
</li>
<li>
<a href="/archives/" class="menu-item">Archives</a>
</li>
</ul>
</nav>
</div>
</div>
<div class="columns">
<div class="column is-two-thirds">
<div class="subscription">
<h5 class="b-header">Subscribe to our newsletter</h5>
<form class="newsletter">
<input type="text" class="input" placeholder="Your email">
<input type="submit" value="subscribe" class="button small">
</form>
</div>
<div class="attribution margin-top-bigger">
<p class="caption">
Except where otherwise
<a href="https://creativecommons.org/policies#license" target="_blank" rel="noopener">noted</a>,
content on this site is licensed under a
<a href="https://creativecommons.org/licenses/by/4.0/" target="_blank" rel="noopener">Creative Commons
Attribution 4.0 International license</a>.
<a href="https://creativecommons.org/website-icons" target="_blank" rel="noopener">Icons</a>
by
<a href="https://fontawesome.com/" target="_blank" rel="noopener">Font Awesome</a>.
</p>
<div class="margin-top-smaller">
<i class="icon margin-right-small is-size-4">cclogo</i>
<i class="icon margin-right-small is-size-4">ccby</i>
</div>
</div>
</div>
<div class="column is-one-third">
<aside class="donate-section">
<h5>Our work relies on you!</h5>
<p>Help us keep the internet free and open.</p>
<a class="button small donate" href="https://creativecommons.org/donate?c_src=website&c_src2=GlobalFooter">
<i class="icon cc-letterheart-filled margin-right-small is-size-5 padding-top-smaller"></i>
Donate now
</a>
</aside>
</div>
</div>
</div>
</div>
</div>
</footer>
</body>