Outdated version

You are browsing the docs for Nexus v1.6.x, the latest release is available here

Views

Views are rooted in the /v1/views/{org_label}/{project_label} collection and are used to index the selected resources into a bucket.

Each view belongs to a project identifier by the label {project_label} inside an organization identifier by the label {org_label}.

view types

There are several types of views, which relies on different technology to perform the indexing

ElasticSearchView

A view which stores the targeted Json resources into an ElasticSearch Document.

The Documents created on each view are isolated from Documents created on other views by using different ElasticSearch indices.

More information

AggregateElasticSearchView

This view describes an aggregation of multiple existing ElasticSearch views. This approach is useful for searching documents across multiple ElasticSearch views.

When querying an AggregateElasticSearchView, the query is performed on each of the described views and the results are aggregated by ElasticSearch.

More information

SparqlView

A view that creates a Sparql namespace. which converts the targeted Json resources intro RDF triples and stores them in a Sparql store.

The triples created on each view are isolated from triples created on another view.

More information

AggregateSparqlView

This view describes an aggregation of multiple existing Sparql views. This approach is useful for searching triples across multiple Sparql views.

When querying an AggregateSparqlView, the query is performed on each of the described views. The Sparql store does not have means for aggregating the query and for that reason this approach is very limited.

More information

CompositeView

A view which is composed by multiple sources and projections.

A source defines from where to retrieve the resources. It is the input for the indexing in a later stage.

A projection defines the type of indexing and the transformations to apply to the data.

Composite views are useful when aggregating data across multiple projects (local or remote) using multiple sources. Afterwards, by defining multiple projections, the data can be adapted to the client needs.

More information

Indexing

All the API calls modifying a view (creation, update, tagging, deprecation) can specify whether the view should be indexed synchronously or in the background. This behaviour is controlled using indexing query param, which can be one of two values:

  • async - (default value) the view will be indexed asynchronously
  • sync - the view will be indexed synchronously and the API call won’t return until the indexing is finished

Passivation

Views are now stopped if no event has been detected for a given period (by default 30 minutes).

This value can be updated by updating the configuration keys: - plugins.blazegraph.idle-timeout - plugins.composite-views.idle-timeout - plugins.elasticsearch.idle-timeout

Setting an infinite time (Inf) will disable this feature.

List views

There are three available endpoints to list views in different scopes.

Within a project

GET /v1/views/{org_label}/{project_label}?from={from}
                                         &size={size}
                                         &deprecated={deprecated}
                                         &rev={rev}
                                         &type={type}
                                         &createdBy={createdBy}
                                         &updatedBy={updatedBy}
                                         &q={search}
                                         &sort={sort}

Within an organization

This operation returns only views from projects defined in the organisation {org_label} and where the caller has the resources/read permission.

GET /v1/views/{org_label}?from={from}
                         &size={size}
                         &deprecated={deprecated}
                         &rev={rev}
                         &type={type}
                         &createdBy={createdBy}
                         &updatedBy={updatedBy}
                         &q={search}
                         &sort={sort}

Within all projects

This operation returns only views from projects where the caller has the resources/read permission.

GET /v1/views?from={from}
             &size={size}
             &deprecated={deprecated}
             &rev={rev}
             &type={type}
             &createdBy={createdBy}
             &updatedBy={updatedBy}
             &q={search}
             &sort={sort}

Parameter description

  • {from}: Number - is the parameter that describes the offset for the current query; defaults to 0
  • {size}: Number - is the parameter that limits the number of results; defaults to 20
  • {deprecated}: Boolean - can be used to filter the resulting views based on their deprecation status
  • {rev}: Number - can be used to filter the resulting views based on their revision value
  • {type}: Iri - can be used to filter the resulting views based on their @type value. This parameter can appear multiple times, filtering further the @type value
  • {createdBy}: Iri - can be used to filter the resulting views based on their creator
  • {updatedBy}: Iri - can be used to filter the resulting views based on the person which performed the last update
  • {search}: String - can be provided to select only the views in the collection that have attribute values matching (containing) the provided string
  • {sort}: String - can be used to sort views based on a payloads’ field. This parameter can appear multiple times to enable sorting by multiple fields. The default is done by _createdBy and @id.

Example

Request
sourcecurl "http://localhost:8080/v1/views/myorg/myproj"
Response
source{
  "@context": [
    "https://bluebrain.github.io/nexus/contexts/metadata.json",
    "https://bluebrain.github.io/nexus/contexts/search.json",
    "https://bluebrain.github.io/nexus/contexts/search-metadata.json"
  ],
  "_total": 3,
  "_results": [
    {
      "@id": "https://bluebrain.github.io/nexus/vocabulary/defaultElasticIndex",
      "@type": [
        "https://bluebrain.github.io/nexus/vocabulary/View",
        "https://bluebrain.github.io/nexus/vocabulary/ElasticSearchView"
      ],
      "_incoming": "http://localhost:8080/v1/schemas/myorg/myproj/nxv:defaultElasticSearchIndex/incoming",
      "_outgoing": "http://localhost:8080/v1/schemas/myorg/myproj/nxv:defaultElasticSearchIndex/outgoing",
      "_self": "http://localhost:8080/v1/schemas/myorg/myproj/nxv:defaultElasticSearchIndex",
      "_constrainedBy": "https://bluebrain.github.io/nexus/schemas/views",
      "_project": "http://localhost:8080/v1/projects/myorg/myproj",
      "_rev": 1,
      "_deprecated": false,
      "_createdAt": "2021-04-18T16:39:22.748Z",
      "_createdBy": "http://localhost:8080/v1/realms/myrealm/users/john",
      "_updatedAt": "2021-04-18T17:10:22.748Z",
      "_updatedBy": "http://localhost:8080/v1/realms/myrealm/users/john"
    },
    {
      "@id": "https://bluebrain.github.io/nexus/vocabulary/defaultSparqlIndex",
      "@type": [
        "https://bluebrain.github.io/nexus/vocabulary/View",
        "https://bluebrain.github.io/nexus/vocabulary/SparqlView"
      ],
      "_incoming": "http://localhost:8080/v1/schemas/myorg/myproj/nxv:defaultSparqlIndex/incoming",
      "_outgoing": "http://localhost:8080/v1/schemas/myorg/myproj/nxv:defaultSparqlIndex/outgoing",
      "_self": "http://localhost:8080/v1/schemas/myorg/myproj/nxv:defaultSparqlIndex",
      "_constrainedBy": "https://bluebrain.github.io/nexus/schemas/views",
      "_project": "http://localhost:8080/v1/projects/myorg/myproj",
      "_rev": 1,
      "_deprecated": false,
      "_createdAt": "2021-04-18T16:39:22.748Z",
      "_createdBy": "http://localhost:8080/v1/realms/myrealm/users/john",
      "_updatedAt": "2021-04-18T17:10:22.748Z",
      "_updatedBy": "http://localhost:8080/v1/realms/myrealm/users/john"
    },
    {
      "@id": "https://bluebrain.github.io/nexus/vocabulary/myview2",
      "@type": [
        "https://bluebrain.github.io/nexus/vocabulary/ElasticSearchView",
        "https://bluebrain.github.io/nexus/vocabulary/View"
      ],
      "_incoming": "http://localhost:8080/v1/schemas/myorg/myproj/nxv:myview/incoming",
      "_outgoing": "http://localhost:8080/v1/schemas/myorg/myproj/nxv:myview/outgoing",
      "_self": "http://localhost:8080/v1/schemas/myorg/myproj/nxv:myview",
      "_constrainedBy": "https://bluebrain.github.io/nexus/schemas/view",
      "_project": "http://localhost:8080/v1/projects/myorg/myproj",
      "_rev": 4,
      "_deprecated": true,
      "_createdAt": "2021-04-18T16:39:22.748Z",
      "_createdBy": "http://localhost:8080/v1/realms/myrealm/users/john",
      "_updatedAt": "2021-04-18T17:10:22.748Z",
      "_updatedBy": "http://localhost:8080/v1/realms/myrealm/users/john"
    }
  ],
  "_next": "http://localhost:8080/v1/views/myorg/myproj?after=%5B1559045718752,%22https://bluebrain.github.io/nexus/vocabulary/myview29%22%5D"
}

Server Sent Events

From Delta 1.5, it is possible to fetch SSEs for all resolvers or just resolvers in the scope of an organization or a project.

GET /v1/views/events # for all view events in the application
GET /v1/views/{org_label}/events # for view events in the given organization
GET /v1/views/{org_label}/{project_label}/events # for view events in the given project

The caller must have respectively the events/read permission on /, {org_label} and {org_label}/{project_label}.

  • {org_label}: String - the selected organization for which the events are going to be filtered
  • {project_label}: String - the selected project for which the events are going to be filtered
  • Last-Event-Id: String - optional HTTP Header that identifies the last consumed resource event. It can be used for cases when a client does not want to retrieve the whole event stream, but to start after a specific event.
Note

The event type for views SSEs have been changed so that it is easier to distinguish them from other types of resources.

Example

Request
sourcecurl "https://localhost:8080/v1/views/events"
Response
sourcedata:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","https://bluebrain.github.io/nexus/contexts/elasticsearch.json"],"@type":"ElasticSearchViewTagAdded","_source":{"includeMetadata": true},"_constrainedBy":"https://bluebrain.github.io/nexus/schemas/views.json","_instant":"2021-04-18T17:10:22.748Z","_organizationUuid":"61c74973-0f04-40f0-a694-7c8ed0fb090f","_project":"http://localhost:8080/v1/projects/myorg/myproject","_projectUuid":"61c74973-0f04-40f0-a694-7c8ed0fb090f","_resourceId":"https://bluebrain.github.io/nexus/vocabulary/blazegraph-id","_rev":1,"_subject":"http://localhost:8080/v1/anonymous","_types":["https://bluebrain.github.io/nexus/vocabulary/ElasticSearchView","https://bluebrain.github.io/nexus/vocabulary/View"],"_uuid":"d6933f15-beca-4058-987f-75f2d71d1228","_viewId":"https://bluebrain.github.io/nexus/vocabulary/blazegraph-id"}
event:BlazegraphViewCreated
id:2

data:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","https://bluebrain.github.io/nexus/contexts/elasticsearch.json"],"@type":"ElasticSearchViewTagAdded","_source":{"includeMetadata": false},"_constrainedBy":"https://bluebrain.github.io/nexus/schemas/views.json","_instant":"2021-04-20T14:22:32.12Z","_organizationUuid":"61c74973-0f04-40f0-a694-7c8ed0fb090f","_project":"http://localhost:8080/v1/projects/myorg/myproject","_projectUuid":"61c74973-0f04-40f0-a694-7c8ed0fb090f","_resourceId":"https://bluebrain.github.io/nexus/vocabulary/blazegraph-id","_rev":2,"_subject":"http://localhost:8080/v1/anonymous","_types":["https://bluebrain.github.io/nexus/vocabulary/ElasticSearchView","https://bluebrain.github.io/nexus/vocabulary/View"],"_uuid":"d6933f15-beca-4058-987f-75f2d71d1228","_viewId":"https://bluebrain.github.io/nexus/vocabulary/blazegraph-id"}
event:BlazegraphViewUpdated
id:2

data:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","https://bluebrain.github.io/nexus/contexts/elasticsearch.json"],"@type":"ElasticSearchViewTagAdded","tag":"mytag","targetRev":1,"_constrainedBy":"https://bluebrain.github.io/nexus/schemas/views.json","_instant":"2021-04-24T06:44:34.546Z","61c74973-0f04-40f0-a694-7c8ed0fb090f":"{{uuid}}","_project":"http://localhost:8080/v1/projects/myorg/myproject","61c74973-0f04-40f0-a694-7c8ed0fb090f","_resourceId":"https://bluebrain.github.io/nexus/vocabulary/elastic-id","_rev":3,"_subject":"http://localhost:8080/v1/anonymous","_types":["https://bluebrain.github.io/nexus/vocabulary/ElasticSearchView","https://bluebrain.github.io/nexus/vocabulary/View"],"_uuid":"d6933f15-beca-4058-987f-75f2d71d1228","_viewId":"https://bluebrain.github.io/nexus/vocabulary/elastic-id"}
event:ElasticSearchViewTagAdded
id:3

data:{"@context":["https://bluebrain.github.io/nexus/contexts/metadata.json","https://bluebrain.github.io/nexus/contexts/blazegraph.json"],"@type":"BlazegraphViewDeprecated","_constrainedBy":"https://bluebrain.github.io/nexus/schemas/views.json","_instant":"2021-04-25T23:59:59.748Z","_organizationUuid":"61c74973-0f04-40f0-a694-7c8ed0fb090f","_project":"http://localhost:8080/v1/projects/myorg/myproject","_projectUuid":"61c74973-0f04-40f0-a694-7c8ed0fb090f","_resourceId":"https://bluebrain.github.io/nexus/vocabulary/elastic-id","_rev":4,"_subject":"http://localhost:8080/v1/anonymous","_types":["https://bluebrain.github.io/nexus/vocabulary/ElasticSearchView","https://bluebrain.github.io/nexus/vocabulary/View"],"_uuid":"d6933f15-beca-4058-987f-75f2d71d1228","_viewId":"https://bluebrain.github.io/nexus/vocabulary/elastic-id"}
event:BlazegraphViewDeprecated
id:4
v1.6.x