Introduction

Enzo Server
  Installation
  Quick Start
  Core Features
    Async Calls
    ConnectionStrings
    Edge Cache
    HTTP Access
    Scheduling
    Views
  Advanced Capabilities
    Change Data Capture
  Administration
    Configuration Settings
    Logins & ACL
    Auditing
    Current Executions
    Linked Server
    SSL

  User Guides
     Sharding
     Sharding Overview

     SharePoint

   Adapters
    All Adapters


  SDK
    Overview
    Installation
    DevHost
    Create A Simple Adapter
    Best Practices
    Developer Guide
      Handler Columns
      Handler Options
      Handler Decorators
      Dynamic Columns
      Table & Table Enumerators
      Virtual Tables



Shard Adapter








This adapter allows you to query multiple heterogeneous systems (shard) in parallel using SQL Server and REST commands


This adapter requires advanced configuration settings; contact support for assistance.



Configuration Settings



Name Description Default
Boolean _isDefault Make this the default configuration. Defaults to true if configName is already the default.
String type The type of the data source (data, shard, view) data
String connectionString The connection string of the data source (or a shard name, or a view name)
String sqlCommand The default SQL (SELECT) statement to execute for this data source
String options An optional comma-separated list of options for the data source (strict, breadcrumb,readonly,timeout=nnn)
String tableName The name of the source (or Enzo) table to use when issuing UPDATE, DELETE, INSERT commands

Handlers



ClearContext Clears the session data source context for statements to execute details 

Arguments


SQL Call

exec shard.clearcontext


Http Call

/bsc/shard/clearcontext

Output Columns

This call does not return data.

execshard Runs the default command of a data source, or a shard, defined in the adapter configuration details 

Arguments

Name Description Default
source_name R The source or shard name

SQL Call

exec shard.execshard 'source'


Http Call

/bsc/shard/execshard

Output Columns

This call does not return data.

execshardsql Runs the SQL command provided against a data source, or a shard, defined in the adapter configuration details 

Arguments

Name Description Default
source_name R The source or shard name
sql R The sql statement to execute (if not provided, will run the data source sql statememts)

SQL Call

exec shard.execshardsql 'source'


Http Call

/bsc/shard/execshardsql

Output Columns

This call does not return data.

GetContext Gets the session data source context currently set for statements to execute details 

Arguments


SQL Call

exec shard.getcontext


Http Call

/bsc/shard/getcontext

Output Columns

This call does not return data.

SetContext Sets the session data source context for statements to execute details 

Arguments

Name Description Default
source_name R The source, view, or shard name to set as the current context

SQL Call

exec shard.setcontext 'context1'


Http Call

/bsc/shard/setcontext

Output Columns

This call does not return data.

SETCONTEXT_ON Indicates that the next SQL statement(s) are used to define a context instead of returning rows of data. details 

Arguments

Name Description Default
value R Indicates if the SETCONTEXT_ON flag should be set

SQL Call

exec shard.SETCONTEXT_ON


Http Call

/bsc/shard/setcontext_on

Output Columns

This call does not return data.