Connect Overview

Skyvia Connect is a cloud service that allows you to quickly and easily expose your data from various sources via OData protocol and make it available in JSON or XML format over the web. It allows you to easily create OData endpoints in convenient GUI, configure them visually.

OData Protocol

OData is a widely accepted open standard protocol for data access over the Internet. It provides queryable and interoperable RESTful APIs for working with data. It allows bi-directional data access with full CRUD support over the HTTP protocol and it provides a query language via specially constructed URLs and full metadata information.

OData standard is developed by OASIS. You can find more information about the OData standard and more useful OData tools and resources on www.odata.org.

Skyvia Connect allows creating endpoints, compatible either with OData v1 - v3, or with OData v4.

OData Endpoints

In Skyvia Connect you create OData endpoints by selecting objects to expose from a data source connection, and selecting fields to expose data from. Data, exposed by OData endpoint can be described by entity data model. The main concepts of OData Entity Data Model are entities, entity types, and entity sets, relations, actions, and functions.

Entities are instances of entity types. Entity types are named structured types, having a key (a property or several properties that uniquely identify entities). Entity types have named properties and navigation properties, which represent relationships between entities. Entity sets are named collections of entities.

Actions and functions are currently not supported in Skyvia.

Creating OData Endpoints

Skyvia offers a convenient GUI editor to create and edit OData endpoints. After you select a connection, you can simply drag data source tables from the connection object list (on the left) to the diagram (on the right).

connect-endpoint-editor-unmarked

When you drag a table to the diagram, Skyvia automatically creates the corresponding entity set and entity type. Skyvia also automatically creates relationships (associations) with other entity types on the diagram, corresponding to tables, with which there are relationships in the data source. If a table references itself in the data source, Skyvia creates a self-referencing relationship on the diagram. By default, Skyvia exposes all the table fields via the OData protocol.

After dragging a table from the data source to the diagram, you can double-click the result entity to tweak it in more details. Double-clicking an entity on the diagram opens the Edit Entity dialog box, which allows you to change the name of the entity and corresponding entity set and see the source table name in the data source. It also allows you to hide some of the table fields so that they won't be exposed via the OData protocol. See more details about this in the Endpoint Editor Page topic.

edit-entity-small

You also can configure relationships between entities. You may edit or delete automatically generated relationships or create your own, custom ones. For example, to edit a relationship, you just need to point a navigation property and click icon-pencil-small edit association. This opens the Edit Association dialog box where you can set the relation cardinality, specify names for the corresponding navigation properties for both sides of the relationship, and select columns, by which the association is built.

association-editor

You can find an instruction on creating an OData endpoint in the How to Configure OData Endpoint topic.

Endpoint Security

Skyvia Connect allows you to create additional security layer over your data source. You can create user accounts with passwords for your OData endpoints and pass these credentials to users you want to share your data with. You don't need to share your original data source credentials with them. You also can limit access to your endpoints by specifying IP address ranges for which access is allowed. Together with exposing only the necessary entities, this makes data sharing via Skyvia Connect convenient and secure. See more details about user account and IP configuration in the Security Settings topic.

note Note

If you don't specify any users, the endpoint data will be publicly available to anyone without authentication, and if you don't specify any IP address ranges, the endpoint data will be available from any IP by default.

Endpoint Details

After you created endpoint, configured its security settings if necessary, you can view its details on the Endpoint Details page. Here you can retrieve the result URL of the OData endpoint that can be used in data consumer applications in order to work with live data from the data source or share this URL with other users. You can also see a brief log of the endpoint activity on this page.

endpoint-details-small

In addition to this brief log, you can click the Log button and view a detailed log with all the requests to an endpoint with their URLs, user names, executed SQL statements, error messages (if any), etc. See more details about logging in the Monitoring Data Access topic.