Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Complex Types - anyKeyValueType

  • Article
  • 1 minutes to read

Description

This type represents a keyValue used by some database operations where the user is required to provide a unique primary key.

        In this simple shortcu example the target has a single column priamry key, the column name is deduced from the table schema

        XML Form
        <keyValue>
          1234
        </keyValue>

        JSON Form
        "keyValue", 1234
        
        In this example the target has a single column priamry key, this time the column is targeted directly. The column must be
        defined the the schema as the tables primary key
        
        XML Form            
        <keyValue>
          <h_id>1234</h_id>
        </keyValue>

        JSON Form
        "keyValue": {
            "h_id": 1234
        }

        In this example the target table requires a composite key made up of two column values

        XML Form
        <keyValue>
          &lt;h_id&gt;smith&lt;/h_id&gt;
          &lt;h_postcode&gt;NW10&lt;/h_postcode&gt;
        </keyValue>
        
        JSON Form
        "keyValue": {
            "h_id": "smith",
            "h_postcode": "NW10"
        }

Properties

This complex type contains no defined properties.

  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document