DOCUMENTATIONAPI REFERENCEAI-Link
DownloadsSupport
Loading search results...
Data Catalog ApiConnection Subgroups

Connection subgroups

You can obtain all the details you need for the connection subgroups in a specified catalog.

Request

The user account used for making this request should have the Manage Data Warehouses permission; for example, organization administrator or super user. For details, see Creating and Editing Roles.

A query for connection subgroups must include the following:

  • The SELECT statement must start with one or more connection subgroup parameters (comma separated).
  • After the parameters you must provide the following data source: FROM $system.DBSCHEMA_CONNECTION_SUBGROUPS

You can request the following connection subgroup parameters:

  • CONNECTOR_TYPE
  • DATABASE
  • EXTRA_JDBC_FLAGS
  • GROUP_ID
  • HOSTS
  • ID
  • IS_KERBEROS_CLIENT_ENABLED
  • MANAGEMENT_CONSOLE_URL
  • NAME
  • PORT
  • QUERY_ROLES
  • USERNAME

For details about the parameter types, see the xsd:schema element in the sample response provided below.

Response

The response contains a <row> element for each connection subgroup in the specified catalog. Each of these elements contains the values of the requested parameters.

Sample request

The example here shows how to make a request with the curl tool:

  • The requested data are subgroup's name (NAME), the connector type (CONNECTOR_TYPE), and extra JDBC flags (EXTRA_JDBC_FLAGS).
  • The request is for the connection subgroups in the Sales Insights catalog.
  • The token is obtained in advance.
  • The query is for the default organization.
  • The address of the AtScale system is: http://example.com:10502/xmla/default

The XML part of the request is as follows:

<?xml version="1.0"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body>
    <Execute xmlns="urn:schemas-microsoft-com:xml-analysis">
      <Command>
        <Statement>SELECT CONNECTOR_TYPE, EXTRA_JDBC_FLAGS, NAME FROM $system.DBSCHEMA_CONNECTION_SUBGROUPS</Statement>
      </Command>
      <Properties>
        <PropertyList>
          <Catalog>Sales Insights</Catalog>
        </PropertyList>
      </Properties>
    </Execute>
  </Body>
</Envelope>

Here is the full form of the curl request:

curl -X POST \
-H "Authorization:Bearer $token" -H 'Content-Type: application/xml' \
-d '<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">\
<Body><Execute xmlns="urn:schemas-microsoft-com:xml-analysis">\
  <Command>\
    <Statement>SELECT CONNECTOR_TYPE, EXTRA_JDBC_FLAGS, NAME FROM $system.DBSCHEMA_CONNECTION_SUBGROUPS</Statement>\
  </Command>\
  <Properties><PropertyList>\
    <Catalog>Sales Insights</Catalog>
  </PropertyList></Properties>\
</Execute></Body></Envelope>' \
http://example.com:10502/xmla/default

Sample response

The response for the sample request above contains <row> elements for each connection subgroup found. As requested, each of these elements contains only subgroup's name, the connector type, and extra JDBC flags:

<row>
  <CONNECTOR_TYPE>mssql</CONNECTOR_TYPE>
  <EXTRA_JDBC_FLAGS>;encrypt=true;trustServerCertificate=true</EXTRA_JDBC_FLAGS>
  <NAME>MSSQL</NAME>
</row>

Here is the full response:

<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <as:queryId xmlns:as="http://xsd.atscale.com/soap_v1" soap:mustUnderstand="0">5b628d4c-722e-4bac-a724-0b64a2ff4fd7</as:queryId>
  </soap:Header>
  <soap:Body>
    <ExecuteResponse xmlns="urn:schemas-microsoft-com:xml-analysis">
      <return>
        <root xmlns="urn:schemas-microsoft-com:xml-analysis:rowset" xmlns:msxmla="http://schemas.microsoft.com/analysisservices/2003/xmla" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
          <xsd:schema xmlns:sql="urn:schemas-microsoft-com:xml-sql" targetNamespace="urn:schemas-microsoft-com:xml-analysis:rowset" elementFormDefault="qualified">
            <xsd:element name="root">
              <xsd:complexType>
                <xsd:sequence minOccurs="0" maxOccurs="unbounded">
                  <xsd:element name="row" type="row"/>
                </xsd:sequence>
              </xsd:complexType>
            </xsd:element>
            <xsd:simpleType name="uuid">
              <xsd:restriction base="xsd:string">
                <xsd:pattern value="[0-9a-zA-Z]{8}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{12}"/>
              </xsd:restriction>
            </xsd:simpleType>
            <xsd:complexType name="xmlDocument">
              <xsd:sequence>
                <xsd:any/>
              </xsd:sequence>
            </xsd:complexType>
            <xsd:complexType name="row">
              <xsd:sequence>
                <xsd:element sql:field="CONNECTOR_TYPE" name="CONNECTOR_TYPE" type="xsd:string" minOccurs="0"/>
                <xsd:element sql:field="EXTRA_JDBC_FLAGS" name="EXTRA_JDBC_FLAGS" type="xsd:string" minOccurs="0"/>
                <xsd:element sql:field="NAME" name="NAME" type="xsd:string" minOccurs="0"/>
              </xsd:sequence>
            </xsd:complexType>
          </xsd:schema>
          <row>
            <CONNECTOR_TYPE>mssql</CONNECTOR_TYPE>
            <EXTRA_JDBC_FLAGS>;encrypt=true;trustServerCertificate=true</EXTRA_JDBC_FLAGS>
            <NAME>MSSQL</NAME>
          </row>
        </root>
      </return>
    </ExecuteResponse>
  </soap:Body>
</soap:Envelope>

More information