Show/Hide Toolbars

TMS XData Documentation

Navigation: » No topics above this level «

Introduction

Scroll Prev Top Next More

TMS XData is a Delphi framework that allows you to create HTTP/HTTPS servers that exposes data through REST/JSON. It is highly integrated with TMS Aurelius in such a way that creating XData services based on applications with existing Aurelius mappings is just a matter of a few lines of code. XData defines URL conventions for adressing resources, and specifies the JSON format of message payloads. It's heavily based on OData standard. Such conventions, with the benefit of existing Aurelius mapping, allows building a full REST/JSON server with minimum code writing. TMS XData uses TMS Sparkle as the core communication library.

 

TMS XData product page: http://www.tmssoftware.com/site/xdata.asp

TMS Software site: http://www.tmssoftware.com

PDF version of this documentation: http://www.tmssoftware.com/business/xdata/doc/xdata_manual.pdf

 

Documentation Topics

 

Introduction

oOverview

oFeatures

oWhat's New

oCopyright Notice

oGetting Support

oBreaking Changes

Getting Started

oQuick Start

oWizard For New XData Server

oCreating the Server Manually

oExample 1: In-memory SQLite for testing/development

oExample 2: MySQL Server with dbExpress (from Delphi code)

oExample 3: MS SQL Server with FireDAC (using TDataModule)

Basic XData Programming

oCreating XData Server

oTXDataServerModule

oIDBConnectionPool Interface

oIDBConnectionFactory Interface

oOpenAPI/Swagger Support

Server-Side Events

oUsing Events

oOnEntityGet Event

oOnEntityList Event

oOnEntityInserting Event

oOnEntityModifying Event

oOnEntityDeleting Event

oOnModuleException Event

oAuthentication Example using JSON Web Token (JWT)

Entity Model

oEntity Model Concepts

oAurelius Equivalence to Entity Model

oUsing TXDataModelBuilder

oMultiple servers and models

URL Conventions

oResource Path

oQuery Options

oBuilt-in Functions

oLiterals in URI

oCustom Functions

JSON Format

oEntity Representation

oCollection of Entities

oIndividual Properties

oError Response

oCanonical Id

Requesting Data

oRequesting Single Entities

oQuerying Collections

oRequesting Associated Entities

oRequesting Individual Properties

oRequesting Streams (Blobs)

oHTTP Request Headers

Data Modification

oCreate an Entity

oUpdate an Entity

oDelete an Entity

oManaging Streams (Blobs)

Service Operations

oService Operations Tutorial

oCreating Service Contract

oService Implementation

oTXDataOperationContext

oServer Memory Management

oInvoking Operations using XData Client

oInvoking Operations using HTTP

TXDataClient

oRequesting a Single Entity

oRequesting an Entity List

oCreating Entities

oUpdating Entities

oRemoving Entities

oInvoking Service Operations

oClient Memory Management

oClient and Multi-Model

oAuthentication Settings

Web Applications with TMS Web Core

oSetting Up the Connection with TXDataWebConnection

oUsing TXDataWebClient

oUsing TXDataWebDataset