%VOSWARNING%


%META:TOPICPARENT{name="ODSProgrammersGuideAPIs"}%

%ODSNAV%


%TOC%

---++ ODS RDF Import API

---+++ DB.DBA.rdf_import
   1. Function <strong>DB.DBA.rdf_import</strong> 
   1. Returns total of imported RDF triples.
   1. Description: Imports RDF data into the RDF QUAD. The function is part of the ODS Framework package. If username and password are passed as pUser and pPassword, then the imported RDF data can be viewed in the user home DAV folder/Uploads/RDF folder. This folder is created the first time the <nowiki>rdf_import</nowiki> API is called (with values for pUser and pPassword).
   1. <nowiki>DB.DBA.rdf_import(in URL varchar, in mode integer, [in graph varchar])</nowiki>
   1. Parameters:
<verbatim>
pURL - RDF URL source;
pMode - 0 or 1; 1 - sponger mode (default); 0 - normal mode
pGraph - if empty, pURL is used as graph;
pUser - user name. 
          - If value is given then a new file is created in the folder '<home>/Uploads/RDF'. 
          - This is dynamic resource - sparql query that select all triplets from the graph pURL 
          - and output format 'RDF' (optional);
pPassword - user password (optional);
pFolder - destination folder path (optional). 
            - If not set then default folder is used from the user's home 
            - directory - '[home dir]/Uploads/RDF/'. 
            - The folder path must end with '/'. 
            - The pUser must have write permissions for pFolder;
</verbatim>
   1.  Return Types: integer - the count of imported triples.
   1.  Error Handling: if not valid URL is provided, is shown error message "ODS10" for invalid data.

---+++DB.DBA.<nowiki>rdf_import_ext</nowiki>
   1. Function <strong>DB.DBA.<nowiki>rdf_import_ext</nowiki></strong> 
   1. Returns total of imported RDF triples.
   1. Description: Imports RDF data into the RDF QUAD. The function is part of the ODS Framework package. If username and password are passed as pUser and pPassword, then the imported RDF data can be viewed in the user home DAV folder/Uploads/RDF folder. This folder is created the first time the rdf_import API is called (with values for pUser and pPassword).
   1. DB.DBA.<nowiki>rdf_import_ext</nowiki>(in pContent varchar[, in pContentMimeType varchar[, in pContentType varchar[, in pSpongerMode integer[, in pGraph varchar[, pUser, [pPassword[, pFolder]]]]]]])
   1. Parameters:
<verbatim>
pContent         - RDF URL source or string;
pContentMimeType - content mime type. Mandatory for string contents;
pContentType     - 'URL' or 'string'. Default value is 'URL';
pSpongerMode     - 0 or 1; Default value is 1 - sponger mode;
pGraph           - if empty, pURL is used as graph. Mandatory for string contents;
pUser            - user name. 
                    - If value is given then a new file is created in the folder '<home>/Uploads/RDF'. 
                    - This is dynamic resource - sparql query that select all triplets from the graph pURL 
                    - and output format 'RDF' (optional);
pPassword        - user password (optional);
pFolder          - destination folder path (optional). 
                    - If not set then default folder is used from the user's home 
                    - directory - '[home dir]/Uploads/RDF/'. 
                    - The folder path must end with '/'. 
                    - The pUser must have write permissions for pFolder;
</verbatim>
   1.  Return Types: integer - the count of imported triples.
   1.  Error Handling: if not valid URL is provided, is shown error message "ODS10" for invalid data.

---+++Examples

   1. Using isql execute the following statement:
<verbatim>
SQL>  select DB.DBA.rdf_import('http://www.openlinksw.com/blog/~kidehen/gems/rss.xml');
</verbatim>
   2. As result 7 triples should be inserted.
   3. You can check the triples from your sparql endpoint: http://[host]:[port]/sparql:
      1. Enter for Default Graph URI: http://www.openlinksw.com/blog/~kidehen/gems/rss.xml
      2. Enter for Query:
<verbatim>
select *
from <http://www.openlinksw.com/blog/~kidehen/gems/rss.xml>
where {?s ?p ?o}
</verbatim>


CategoryODS CategoryApplicationController CategoryAPI CategoryToBeDone CategoryProgrammersGuide

%ODSCOPY%