Create a spatial index using the Hadoop API

post

/spatialviewer/api/v1/createIndex

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

• Request
• Response

Request

Supported Media Types

• application/json

Query Parameters

asynchronous

Type: boolean

if true the index is created asynchronously.

Default Value

false

Body Parameter

Index details

Root Schema : HadoopIndexInfo

Type: object

Properties

dataPath

Type: string

Path of the file or files to index in HDFS.

Example: /user/oracle/spatialviewer/tweetsJune.json

indexName

Type: string

The index name.

Example: TweetsJune

indexPath

Type: string

New index path. This is the job output path.

Example: /user/oracle/spatialviewer/TweetsJune

inputFormatClass

Type: string

The input format class.

Example: oracle.spatial.hadoop.vector.geojson.mapred.GeoJsonInputFormat

jarWithNeededClasses

Type: 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

Type: 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

Type: string

The class that provides the spatial information.

Example: oracle.spatial.hadoop.vector.geojson.GeoJsonRecordInfoProvider

srid

Type: integer (int32)

SRID of the geometries to be indexed.

Example: 8307

tolerance

Type: number (double)

Double value that represents the tolerance used when performing spatial operations.

Example: 0.05

useMVSuggest

Type: string

True if the MVSuggest (data enrichment) service must be used, false otherwise.

Example: false

Response

Supported Media Types

• application/json

201 Response

successful index creation

Body

Root Schema : CreateHadoopIndexJobResponse

Type: object

Properties

o:successCode

Type: string

The success code.

Example: SV-05002

response

Type: string

The response contains the location of the new created index.

Example: hdfs://<namenode>:8020/user/oracle/spatialviewer/TweetsJune

status

Type: string

success or error

Example: success

title

Type: string

Service title.

Example: Create Index.

202 Response

accepted asynchronous index creation

Body

Root Schema : AsyncCreateHadoopIndexJobResponse

Type: object

Properties

o:successCode

Type: string

The success code.

Example: SV-05002

response

Type: 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.mananger.webapp:8088

status

Type: string

success or error

Example: success

title

Type: string

Service title.

Example: Create Index.