Jump to

• Request
• Response
• Examples

Create a spatial index using the Hadoop API

post

/spatialviewer/api/v1/hadoop/createIndex

The index metadata directory is the directory index_metadata contained in the SpatialViewer HDFS working directory (see SpatialViewer configuration).

Request

Supported Media Types

• application/json

Query Parameters

• asynchronous: boolean
  if true the index is created asynchronously.

  Default Value: false

Body ()

Index details

Root Schema : HadoopIndexInfo

Type: object

Show Source

• dataPath(optional): string
  Path of the file or files to index in HDFS.

  Example: /user/oracle/spatialviewer/tweetsJune.json
• indexName(optional): string
  The index name.

  Example: TweetsJune
• indexPath(optional): string
  New index path. This is the job output path.

  Example: /user/oracle/spatialviewer/TweetsJune
• inputFormatClass(optional): string
  The input format class.

  Example: oracle.spatial.hadoop.vector.geojson.mapred.GeoJsonInputFormat
• jarWithNeededClasses(optional): string
  jar name with the user-defined classes like custom RecordInfoProvider or InputFormat. If the InputFormat class or the RecordInfoProvider class is not in the API, or in the hadoop API classes, then a jar with the user-defined classes must be provided. To be able to use this jar the user must add it in the /opt/oracle/oracle-spatial-graph/spatial/web-server/spatialviewer/WEB-INF/lib directory and restart the server. Optional property.

  Example: myjar.jar
• jobtemplates(optional): string
  When using the MVSuggest service, the user can define the templates (file names) used to create the index. See examples on how to use the MVSuggest (data enrichment service) in the folder /opt/oracle/oracle-spatial-graph/spatial/vector/examples. Optional property.

  Example: world_continents,world_countries,world_states_provinces
• recordInfoProviderClass(optional): string
  The class that provides the spatial information.

  Example: oracle.spatial.hadoop.vector.geojson.GeoJsonRecordInfoProvider
• srid(optional): integer(int32)
  SRID of the geometries to be indexed.

  Example: 8307
• tolerance(optional): number(double)
  Double value that represents the tolerance used when performing spatial operations.

  Example: 0.05
• useMVSuggest(optional): string
  True if the MVSuggest (data enrichment) service must be used, false otherwise.

  Example: false

{
    "type":"object",
    "properties":{
        "indexName":{
            "type":"string",
            "description":"The index name.",
            "example":"TweetsJune"
        },
        "dataPath":{
            "type":"string",
            "description":"Path of the file or files to index in HDFS.",
            "example":"/user/oracle/spatialviewer/tweetsJune.json"
        },
        "indexPath":{
            "type":"string",
            "description":"New index path. This is the job output path.",
            "example":"/user/oracle/spatialviewer/TweetsJune"
        },
        "srid":{
            "type":"integer",
            "description":"SRID of the geometries to be indexed.",
            "format":"int32",
            "example":8307
        },
        "tolerance":{
            "type":"number",
            "description":"Double value that represents the tolerance used when performing spatial operations.",
            "format":"double",
            "example":0.05
        },
        "jarWithNeededClasses":{
            "type":"string",
            "description":"jar name with the user-defined classes like custom RecordInfoProvider or InputFormat. If the InputFormat class or the RecordInfoProvider class is not in the API, or in the hadoop API classes, then a jar with the user-defined classes must be provided. To be able to use this jar the user must add it in the /opt/oracle/oracle-spatial-graph/spatial/web-server/spatialviewer/WEB-INF/lib directory and restart the server. Optional property.",
            "example":"myjar.jar"
        },
        "inputFormatClass":{
            "type":"string",
            "description":"The input format class.",
            "example":"oracle.spatial.hadoop.vector.geojson.mapred.GeoJsonInputFormat"
        },
        "recordInfoProviderClass":{
            "type":"string",
            "description":"The class that provides the spatial information.",
            "example":"oracle.spatial.hadoop.vector.geojson.GeoJsonRecordInfoProvider"
        },
        "useMVSuggest":{
            "type":"string",
            "description":"True if the MVSuggest (data enrichment) service must be used, false otherwise.",
            "example":false
        },
        "jobtemplates":{
            "type":"string",
            "description":"When using the MVSuggest service, the user can define the templates (file names) used to create the index. See examples on how to use the MVSuggest (data enrichment service) in the folder /opt/oracle/oracle-spatial-graph/spatial/vector/examples. Optional property.",
            "example":"world_continents,world_countries,world_states_provinces"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

successful index creation

Body ()

Root Schema : CreateHadoopIndexJobResponse

Type: object

Show Source

• o:successCode(optional): string
  The success code.

  Example: SV-05002
• response(optional): string
  The response contains the location of the new created index.

  Example: hdfs://<namenode>:8020/user/oracle/spatialviewer/TweetsJune
• status(optional): string
  success or error

  Example: success
• title(optional): string
  Service title.

  Example: Create Index.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"success"
        },
        "title":{
            "type":"string",
            "description":"Service title.",
            "example":"Create Index."
        },
        "o:successCode":{
            "type":"string",
            "description":"The success code.",
            "example":"SV-05002"
        },
        "response":{
            "type":"string",
            "description":"The response contains the location of the new created index.",
            "example":"hdfs://<namenode>:8020/user/oracle/spatialviewer/TweetsJune"
        }
    }
}

202 Response

accepted asynchronous index creation

Body ()

Root Schema : AsyncCreateHadoopIndexJobResponse

Type: object

Show Source

• o:successCode(optional): string
  The success code.

  Example: SV-05002
• response(optional): string
  The response contains the location of the resource manager web application URL to track the job (see in the configuration the Hadoop parameter yarn.resourcemanager.webapp.address).

  Example: http://resource.manager.webapp:8088
• status(optional): string
  success or error

  Example: success
• title(optional): string
  Service title.

  Example: Create Index.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"success"
        },
        "title":{
            "type":"string",
            "description":"Service title.",
            "example":"Create Index."
        },
        "o:successCode":{
            "type":"string",
            "description":"The success code.",
            "example":"SV-05002"
        },
        "response":{
            "type":"string",
            "description":"The response contains the location of the resource manager web application URL to track the job (see in the configuration the Hadoop parameter yarn.resourcemanager.webapp.address).",
            "example":"http://resource.manager.webapp:8088"
        }
    }
}

Back to Top

Examples

The following example shows how to create a Hadoop index by submitting a POST request on the REST resource using cURL.

curl -v -X POST "http://localhost:8045/spatialviewer/api/v1/hadoop/createIndex" -H  "accept: application/json" -H  "content-type: application/json" -d "{  \"indexName\": \"tweetsJanuary\",  \"dataPath\": \"/user/oracle/tweets.json\",  \"indexPath\": \"/user/oracle/tweetsJanuary\",  \"srid\": 8307,  \"tolerance\": 0.05, \"inputFormatClass\": \"oracle.spatial.hadoop.vector.geojson.mapred.GeoJsonInputFormat\",  \"recordInfoProviderClass\": \"oracle.spatial.hadoop.vector.geojson.GeoJsonRecordInfoProvider\",  \"useMVSuggest\": false}" 

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 201 Created Date: Wed, 15 Nov 2017 17:50:38 GMT Location: hdfs://localhost:8020/user/oracle/tweetsJanuary Access-Control-Allow-Origin: * Access-Control-Allow-Credentials: true Access-Control-Allow-Methods: GET, POST, DELETE, PUT Access-Control-Allow-Headers: Content-Type, Accept Transfer-Encoding: chunked  Content-Type: application/json

Example of Response Body

The following example shows the contents of the response body in JSON format:

{"status" : "success", "title" : "Create Index.", "o:successCode" : "SV-05002", "response" : "hdfs://localhost:8020/user/oracle/tweetsJanuary"} 

Back to Top