Examples of Open Data Tables with JavaScript

Hello World Table

The following Open Data Table allows you to search a fictional table in which "a" is the path and "b" is the term.

This table showcases the following:

use of E4X to form the response

Run this example in the YQL console.

Yahoo! Messenger Status

The following Open Data Table allows you to see the status of a Yahoo! Messenger user.

The table showcases the following:

use of JavaScript to check Yahoo! Messenger status
use of E4X to form the response

<?xml version="1.0" encoding="UTF-8"?>
<table xmlns="http://query.yahooapis.com/v1/schema/table.xsd">
  <meta>
    <sampleQuery>select * from {table} where u='sample_id';</sampleQuery>
  </meta>
  <bindings>
    <select itemPath="" produces="XML">
      <urls>
        <url>http://opi.yahoo.com/online?m=t</url>
      </urls>
      <inputs>
        <key id='u' type='xs:string' paramType='query' required="true" />
      </inputs>
      <execute><![CDATA[
          
          //get plain text back from OPI endpoint
          rawStatus = request.get().response;

//check if users is not offline
          if (!rawStatus.match("NOT ONLINE")) {
              status = "online";
          } else {
              status = "offline";
          }

//return results as XML using e4x
          response.object = 
          <messengerstatus>
             <yahoo_id>{u}</yahoo_id>
             <status>{status}</status>
          </messengerstatus>;
      ]]></execute>
    </select> 
  </bindings>
</table>

Run this example in the YQL console.

OAuth Signed Request to Netflix

The following Open Data Table allows you to make a two-legged OAuth signed request to Netflix. It performs a search on the Netflix catalog for specific titles.

This table showcases the following:

access an authenticating API that requires signatures
use an external JavaScript library

<?xml version="1.0" encoding="UTF-8"?>
<table xmlns="http://query.yahooapis.com/v1/schema/table.xsd" https="true">
    <meta>
        <author>Paul Donnelly</author>
        <documentationURL>http://developer.netflix.com/docs/REST_API_Reference#0_52696</documentationURL>
    </meta>
      <bindings>
        <select itemPath="" produces="XML" >
          <urls>
            <url env="all">http://api.netflix.com/catalog/titles/</url>
          </urls>
         <paging model="offset">
           <start id="start_index" default="0" />
           <pagesize id="max_results" max="100" />
           <total default="10" />
         </paging>
          <inputs>
                <key id="term" type="xs:string" paramType="query" required="true" />
                <key id="ck" type="xs:string" paramType="variable" required="true" />
                <key id="cks" type="xs:string" paramType="variable" required="true" />
          </inputs>
          <execute><![CDATA[
// Include the OAuth libraries from oauth.net
y.include("http://oauth.googlecode.com/svn/code/javascript/oauth.js");
y.include("http://oauth.googlecode.com/svn/code/javascript/sha1.js");

// Collect all the parameters
var encodedurl = request.url;
var accessor = { consumerSecret: cks, tokenSecret: ""};
var message = { action: encodedurl, method: "GET", parameters: [["oauth_consumer_key",ck],["oauth_version","1.0"]]};
OAuth.setTimestampAndNonce(message);

// Sign the request
OAuth.SignatureMethod.sign(message, accessor);

try {
   // get the content from service along with the OAuth header, and return the result back out
   response.object = request.contentType('application/xml').header("Authorization", OAuth.getAuthorizationHeader("netflix.com", message.parameters)).get().response;
} catch(err) {
   response.object = {'result':'failure', 'error': err};
}
          ]]></execute>
        </select>
      </bindings>
</table>

Run this example in the YQL console.

Request for a Flickr frob

The following Open Data Table example returns the frob, which is analogous to the request token in OAuth.

This table showcases the following:

access an authenticating API that requires signatures
use an external JavaScript library
sign a request, then send the request using y.rest
require the HTTPS protocol (since private keys are being transmitted)

<?xml version="1.0" encoding="UTF-8" ?>
// https="true" ensures that only HTTPs connections are allowed
<table xmlns="http://query.yahooapis.com/v1/schema/table.xsd" https="true">
  <meta>
    <sampleQuery> select * from {table}</sampleQuery>
  </meta>
  <bindings>
    <select itemPath="rsp" produces="XML">
      <urls>
        <url>http://api.flickr.com/services/rest/</url>
      </urls>
      <inputs>
        <key id='method' type='xs:string' paramType='variable' const="true" default="flickr.auth.getFrob" />
        <key id='api_key' type='xs:string' paramType='variable' required="true" />
        <key id='secret' type='xs:string' paramType='variable' required="true" />
      </inputs>
      <execute><![CDATA[
// Include the flickr signing library
y.include("http://www.yqlblog.net/samples/flickr.js");
// GET the flickr result using a signed url
var fs = new flickrSigner(api_key,secret);
response.object = y.rest(fs.createUrl({method:method, format:""})).get().response();
      ]]></execute>
    </select>
  </bindings>
</table>

Run this example in the YQL console.

CSS Selector for HTML

The following Open Data Table allows you to filter HTML using CSS selectors.

This table showcases the following:

importing external JavaScript utility functions
calling a YQL query within execute

Run this example in the YQL console.

Yahoo! Developer Network

Yahoo! Query Language