forked from yql/yql-tables
/
index.html
164 lines (162 loc) · 13.2 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
<!DOCTYPE HTML>
<html>
<head>
<link rel="stylesheet" type="text/css" href="http://yui.yahooapis.com/combo?3.4.0/build/cssreset/cssreset-min.css&3.4.0/build/cssfonts/cssfonts-min.css&3.4.0/build/cssgrids/cssgrids-min.css&3.4.0/build/cssbase/cssbase-min.css">
<link rel="stylesheet" href="http://l.yimg.com/rt/index.css">
<title>YQL - Community Open Data Tables</title>
</head>
<body onload="createGridder()">
<!-- top section -->
<div id="top">
<!-- navigation -->
<nav>
<a id="name" href="./">datatables.org</a>
<span id="external">
<a target="_blank" href="http://www.yqlblog.net/">blog</a>
<a target="_blank" href="http://github.com/yql/yql-tables/tree/master">github</a>
<a target="_blank" href="http://developer.yahoo.net/forum/index.php?showforum=41">forum</a>
<a target="_blank" href="http://www.datatables.org/healthchecker">healthchecker</a>
<a target="_blank" href="http://www.datatables.org/healthchecker/lint">lint</a>
</span>
</nav>
<div id="track">
<div id="marker"></div>
</div>
<!-- middle section -->
<div id="middle">
<div id="middlestuff">
<a class="icons" href="#" id="home"><span id="homeHover" class="hover"></span><span id="homeUnder"></span></a>
<a class="icons" href="#" id="start"><span id="startHover" class="hover"></span><span id="startUnder"></span></a>
<a class="icons" href="#" id="dev"><span id="devHover" class="hover"></span><span id="devUnder"></span></a>
<a class="icons" href="#" id="what"><span id="whatHover" class="hover"></span><span id="whatUnder"></span></a>
<a class="icons" href="#" id="opendata"><span id="opendataHover" class="hover"></span><span id="opendataUnder"></span></a>
</div>
</div>
<div id="bottom">
<div id="spotlight">
<div id="panel">
<article>
<h1>Community Open Data Tables for YQL</h1>
<p>What if there was just a single, uniform way of using any web-service or data source like Amazon, iTunes, or Twitter?</p>
<p>With YQL and community open data tables there is.</p>
<p>The YQL (Yahoo! Query Language) platform enables developers to query, filter, and combine data across the web through a single interface. It exposes a SQL-like syntax that is both familiar to developers and expressive enough for getting the right data. </p>
<p>Open Data Tables are XML files that can be "plugged" into the Yahoo! Query Language open platform (YQL). These files describe how the YQL SQL-like language can be mapped onto any web service or source on internet. Once mapped, these data sources can be used by developers in many ways in YQL.</p>
<p>To get started with using YQL and community Open Data tables, check out the Getting Started section.</p>
</article>
<article>
<h1>Getting Started</h1>
<h2>Using community Open Data tables with YQL</h2>
<p>In order to use YQL with the community tables, you must pass in the <a target="_blank" href="http://www.datatables.org/alltables.env">datatables env file</a>. You can do this on the YQL console as <a target="_blank" href="http://developer.yahoo.com/yql/console/?q=select%20*%20from%20internet&env=store://datatables.org/alltableswithkeys">part of a YQL statement</a>, or by <a target="_blank" href="http://developer.yahoo.com/yql/console/?env=store://datatables.org/alltableswithkeys">passing in a query parameter</a>.</p>
<p>YQL supports three SQL-like verbs:<p>
<ol>
<li><b>SHOW</b> for getting a list of the tables/data sources supported by the language/platform.</li>
<li><b>DESC</b> for describing the input fields for a table and other meta information;</li>
<li><b>SELECT</b> for fetching, combining, filtering and projecting data</li>
</ol>
<p>The following examples show how each of these verbs can be used for practical applications:</p>
<div id="allexamples">
<span class="examples">
<div class="headers">SHOW</div>
<ul class="showcase">
<li><a target="_blank" href="http://developer.yahoo.com/yql/console/?q=show%20tables">Show all builtin tables</a></li>
<li><a target="_blank" href="http://developer.yahoo.com/yql/console/?q=show%20tables&env=store://datatables.org/alltableswithkeys">Show all community tables</a></li>
</ul>
</span>
<span class="examples">
<div class="headers">DESCRIBE</div>
<ul class="showcase">
<li><a target="_blank" href="http://developer.yahoo.com/yql/console/#h=desc%20maps.map">Get a description of Yahoo! Maps</a></li>
<li><a target="_blank" href="http://developer.yahoo.com/yql/console/?q=desc%20maps.map&env=store://datatables.org/alltableswithkeys#h=desc%20amazon.ecs">Get a description of Amazon ECS</a></li>
<li><a target="_blank" href="http://developer.yahoo.com/yql/console/?q=desc%20maps.map&env=store://datatables.org/alltableswithkeys#h=desc%20apple.itunes">Get a description of iTunes</a></li>
</ul>
</span>
<span class="examples">
<div class="headers">SELECT</div>
<ul class="showcase">
<li><a target="_blank" href="http://developer.yahoo.com/yql/console/#h=select%20*%20from%20weather.forecast%20where%20location%3D93463">Get the weather for zipcode 93463</a></li>
<li><a target="_blank" href="http://developer.yahoo.com/yql/console/?q=show%20tables&env=store://datatables.org/alltableswithkeys#h=select%20*%20from%20deviantart.search%20where%20query%3D%22brandonrp%22">Get some artwork from deviantART</a></li>
<li><a target="_blank" href="http://developer.yahoo.com/yql/console/?q=show%20tables&env=store://datatables.org/alltableswithkeys#h=select%20*%20from%20apple.itunes%20where%20term%3D%27Deep%20Purple%27%20and%20media%3D%27all%27%20and%20entity%3D%27allTrack%27%20and%20attribute%3D%27allArtistTerm%27%20and%20limit%3D%27100%27%20and%20sort%3D%27recent%27%3B">Get all media related to Deep Purple from iTunes</a></li>
</ul>
</span>
</div>
<p>For more information on how to use YQL, please refer to the <a target="_blank" href="http://developer.yahoo.com/yql/guide/yql_users_guide.html">YQL Developer Guide</a>.</p>
<br/>
<br/>
<h2>How to contribute an Open Data table</h2>
<p>A quick read of the YQL guide is a great starting point, in particular the sections on <a target="_blank" href="http://developer.yahoo.com/yql/guide/yql_users_guide.html">Open Data tables</a> and <a target="_blank" href="http://developer.yahoo.com/yql/guide/yql-execute-chapter.html">Running your own code with Execute in Open Data Tables</a>.</p>
<p>Another easy way of working out how to do something is to look at <a target="_blank" href="http://github.com/yql/yql-tables/tree/master"> someone else's open data table</a> that wraps a data source similar to what you want to enable.</p>
</article>
<article>
<h1>Developer Tools</h1>
<p>The YQL Developer Tools were created to assist developers in creating and debugging Open Data tables.</p>
<ul id="toolslist">
<li>
<a target="_blank" href="http://www.datatables.org/healthchecker/lint">
<img src="http://l.yimg.com/rt/lint.png"/>
<h2>YQL Lint</h2>
<p>Similar to jsonlint, YQL Lint will check your Open Data Table XML for any syntax flaws or execution conflicts with YQL.</p>
</a>
</li>
<li>
<a target="_blank" href="http://www.datatables.org/healthchecker/">
<img src="http://l.yimg.com/rt/tablehealth.png"/>
<h2>YQL TableHealth</h2>
<p>This is a tool designed to provide a quick general overview of how‚ "healthy" the community Open Data tables are.</p>
</a>
</li>
</ul>
</article>
<article>
<h1>What is YQL?</h1>
<p>YQL (Yahoo Query Language), is a tool that allows you to query, filter, and combine data across the web. Some of the features include:</p>
<ul id="featureslist">
<li>
<span id="y" class="featureimg"></span>
<span class="desc">
<div class="headers">Direct access to Yahoo! content</div>
<p>YQL can directly tap into the source of Yahoo! content.</p>
</span>
</li>
<li>
<span id="cloud" class="featureimg"></span>
<span class="desc">
<div class="headers">Cloud storage</div>
<p>YQL allows you to store and use data using YQL itself on Yahoo!'s Sherpa cloud storage infrastructure..</p>
</span>
</li>
<li>
<span id="security" class="featureimg"></span>
<span class="desc">
<div class="headers">Security</div>
<p>YQL implements several security features such as Access-Control-Allow-Origins and OAuth 1.0.</p>
</span>
</li>
</ul>
<p>For a full list of features, please refer to the <a target="_blank" href="http://developer.yahoo.com/yql/">main YQL website</a>.</p>
</article>
<article>
<h1>Open Data Tables</h1>
<h2>What are Open Data Tables?</h2>
<p>Open Data Tables are XML files that can be "plugged" into the Yahoo! Query Language open platform (YQL). These files describe how the YQL SQL-like language can be mapped onto any web service or source on internet. Once mapped, these data sources can be used by developers in many ways in YQL.</p>
<h2>What are Community Open Data Tables?</h2>
<p>While anyone can develop and share an open data table for YQL, we are encouraging the community of open data table developers to contribute their tables to the open data tables <a target="_blank" href="http://github.com/yql/yql-tables/tree/master">github</a> project. This makes tables much easier to find and share, and try out in the YQL console.</p>
<h2>Why isn't this site on github?</h2>
<p>While github is a great source control site, it's not intended to serve content quickly. datatables.org keeps a copy of the github master tree and automatically creates a single "env" file. Environment files enable the YQL console and web service to load up many open data tables from a single URL.</p>
</article>
</div>
</div>
</div>
<footer><p>Copyright © 2011 Yahoo! Inc. All rights reserved. <span id="noun">Icons courtesy of the <a target="_blank" href="http://www.thenounproject.com/">Noun Project</a>.</span></p></footer>
<!-- javascript dependencies -->
<script src="http://yui.yahooapis.com/3.4.0/build/simpleyui/simpleyui-min.js"></script>
<script src="http://l.yimg.com/rt/index.js"></script>
<!--
<script>
createGridder = function() {
return;
document.body.appendChild(document.createElement('script')).src='960.js';
}
</script>
-->
</body>
</html>