Skip to main content
GET
/
activeviam
/
pivot
/
rest
/
v10
/
cube
/
query
/
mdx
/
queryplan
Gets the query plans for an MDX SELECT query. Note that the given MDX is run and the result is computed but only the query plans are returned.
curl --request GET \
  --url http://localhost:9090/activeviam/pivot/rest/v10/cube/query/mdx/queryplan
import requests

url = "http://localhost:9090/activeviam/pivot/rest/v10/cube/query/mdx/queryplan"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('http://localhost:9090/activeviam/pivot/rest/v10/cube/query/mdx/queryplan', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "9090",
  CURLOPT_URL => "http://localhost:9090/activeviam/pivot/rest/v10/cube/query/mdx/queryplan",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:9090/activeviam/pivot/rest/v10/cube/query/mdx/queryplan"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("http://localhost:9090/activeviam/pivot/rest/v10/cube/query/mdx/queryplan")
  .asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:9090/activeviam/pivot/rest/v10/cube/query/mdx/queryplan")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "aggregateRetrievals": [
    {
      "filterId": 123,
      "horizontalDispatching": {
        "dispatchingPerApplication": [
          {
            "applicationName": "<string>",
            "dispatchingPerLevel": {}
          }
        ]
      },
      "location": [
        {
          "dimension": "<string>",
          "hierarchy": "<string>",
          "level": [
            "<string>"
          ],
          "path": [
            {}
          ]
        }
      ],
      "measureProvider": "<string>",
      "measures": [
        "<string>"
      ],
      "partialProviderName": "<string>",
      "partitioning": "<string>",
      "resultSizes": [
        123
      ],
      "retrievalId": 123,
      "timingInfo": {},
      "type": "<string>",
      "underlyingDataNodes": [
        "<string>"
      ]
    }
  ],
  "databaseDependencies": {},
  "databaseRetrievals": [
    {
      "condition": "<string>",
      "fields": [
        "<string>"
      ],
      "joinedMeasure": [
        "<string>"
      ],
      "resultSizes": [
        123
      ],
      "retrievalId": 123,
      "store": "<string>",
      "timingInfo": {}
    }
  ],
  "dependencies": {},
  "planInfo": {},
  "queryFilters": [
    {
      "description": "<string>",
      "id": 123
    }
  ],
  "querySummary": {
    "measures": [
      "<string>"
    ],
    "partialProviders": [
      "<string>"
    ],
    "partitioningCountByType": {},
    "resultSizeByPartitioning": {},
    "retrievalsCountByType": {},
    "totalDatabaseResultSize": 123,
    "totalRetrievals": 123
  }
}
[
  {
    "aggregateRetrievals": [
      {
        "filterId": 123,
        "horizontalDispatching": {
          "dispatchingPerApplication": [
            {
              "applicationName": "<string>",
              "dispatchingPerLevel": {}
            }
          ]
        },
        "location": [
          {
            "dimension": "<string>",
            "hierarchy": "<string>",
            "level": [
              "<string>"
            ],
            "path": [
              {}
            ]
          }
        ],
        "measureProvider": "<string>",
        "measures": [
          "<string>"
        ],
        "partialProviderName": "<string>",
        "partitioning": "<string>",
        "resultSizes": [
          123
        ],
        "retrievalId": 123,
        "timingInfo": {},
        "type": "<string>",
        "underlyingDataNodes": [
          "<string>"
        ]
      }
    ],
    "databaseDependencies": {},
    "databaseRetrievals": [
      {
        "condition": "<string>",
        "fields": [
          "<string>"
        ],
        "joinedMeasure": [
          "<string>"
        ],
        "resultSizes": [
          123
        ],
        "retrievalId": 123,
        "store": "<string>",
        "timingInfo": {}
      }
    ],
    "dependencies": {},
    "planInfo": {},
    "queryFilters": [
      {
        "description": "<string>",
        "id": 123
      }
    ],
    "querySummary": {
      "measures": [
        "<string>"
      ],
      "partialProviders": [
        "<string>"
      ],
      "partitioningCountByType": {},
      "resultSizeByPartitioning": {},
      "retrievalsCountByType": {},
      "totalDatabaseResultSize": 123,
      "totalRetrievals": 123
    }
  }
]
[
  {
    "aggregateRetrievals": [
      {
        "filterId": 123,
        "horizontalDispatching": {
          "dispatchingPerApplication": [
            {
              "applicationName": "<string>",
              "dispatchingPerLevel": {}
            }
          ]
        },
        "location": [
          {
            "dimension": "<string>",
            "hierarchy": "<string>",
            "level": [
              "<string>"
            ],
            "path": [
              {}
            ]
          }
        ],
        "measureProvider": "<string>",
        "measures": [
          "<string>"
        ],
        "partialProviderName": "<string>",
        "partitioning": "<string>",
        "resultSizes": [
          123
        ],
        "retrievalId": 123,
        "timingInfo": {},
        "type": "<string>",
        "underlyingDataNodes": [
          "<string>"
        ]
      }
    ],
    "databaseDependencies": {},
    "databaseRetrievals": [
      {
        "condition": "<string>",
        "fields": [
          "<string>"
        ],
        "joinedMeasure": [
          "<string>"
        ],
        "resultSizes": [
          123
        ],
        "retrievalId": 123,
        "store": "<string>",
        "timingInfo": {}
      }
    ],
    "dependencies": {},
    "planInfo": {},
    "queryFilters": [
      {
        "description": "<string>",
        "id": 123
      }
    ],
    "querySummary": {
      "measures": [
        "<string>"
      ],
      "partialProviders": [
        "<string>"
      ],
      "partitioningCountByType": {},
      "resultSizeByPartitioning": {},
      "retrievalsCountByType": {},
      "totalDatabaseResultSize": 123,
      "totalRetrievals": 123
    }
  }
]

Query Parameters

mdx
string
required

The query to run

timeout
integer<int32>

The query timeout limit in seconds.

asSummary
string
default:false

Whether ask for a summary or full query plan export.

Response

The query plans resulting from the MDX SELECT query.

aggregateRetrievals
object[]
databaseDependencies
object
databaseRetrievals
object[]
dependencies
object
planInfo
object
queryFilters
object[]
querySummary
object