Skip to content

Latest commit

 

History

History
278 lines (199 loc) · 10.3 KB

DerivedTableApi.md

File metadata and controls

278 lines (199 loc) · 10.3 KB
Raw

Swagger\Client\DerivedTableApi

All URIs are relative to https://localhost:20000/api/3.1

Method HTTP request Description
checkPdtBuild GET /derived_table/{materialization_id}/status Check status of a PDT materialization
graphDerivedTablesForModel GET /derived_table/graph/model/{model} Get Derived Table graph for model
graphDerivedTablesForView GET /derived_table/graph/view/{view} Get subgraph of derived table and dependencies
startPdtBuild GET /derived_table/{model_name}/{view_name}/start Start a PDT materialization
stopPdtBuild GET /derived_table/{materialization_id}/stop Stop a PDT materialization

checkPdtBuild

\Swagger\Client\Model\MaterializePDT checkPdtBuild($materialization_id)

Check status of a PDT materialization

Check status of PDT materialization

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\DerivedTableApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$materialization_id = "materialization_id_example"; // string | The materialization id to check status for.

try {
    $result = $apiInstance->checkPdtBuild($materialization_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DerivedTableApi->checkPdtBuild: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
materialization_id string The materialization id to check status for.

Return type

\Swagger\Client\Model\MaterializePDT

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

graphDerivedTablesForModel

\Swagger\Client\Model\DependencyGraph graphDerivedTablesForModel($model, $format, $color)

Get Derived Table graph for model

Discover information about derived tables

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\DerivedTableApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$model = "model_example"; // string | The name of the Lookml model.
$format = "format_example"; // string | The format of the graph. Valid values are [dot]. Default is `dot`
$color = "color_example"; // string | Color denoting the build status of the graph. Grey = not built, green = built, yellow = building, red = error.

try {
    $result = $apiInstance->graphDerivedTablesForModel($model, $format, $color);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DerivedTableApi->graphDerivedTablesForModel: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
model string The name of the Lookml model.
format string The format of the graph. Valid values are [dot]. Default is `dot` [optional]
color string Color denoting the build status of the graph. Grey = not built, green = built, yellow = building, red = error. [optional]

Return type

\Swagger\Client\Model\DependencyGraph

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

graphDerivedTablesForView

\Swagger\Client\Model\DependencyGraph graphDerivedTablesForView($view, $models, $workspace)

Get subgraph of derived table and dependencies

Get the subgraph representing this derived table and its dependencies.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\DerivedTableApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$view = "view_example"; // string | The derived table's view name.
$models = "models_example"; // string | The models where this derived table is defined.
$workspace = "workspace_example"; // string | The model directory to look in, either `dev` or `production`.

try {
    $result = $apiInstance->graphDerivedTablesForView($view, $models, $workspace);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DerivedTableApi->graphDerivedTablesForView: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
view string The derived table's view name.
models string The models where this derived table is defined. [optional]
workspace string The model directory to look in, either `dev` or `production`. [optional]

Return type

\Swagger\Client\Model\DependencyGraph

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

startPdtBuild

\Swagger\Client\Model\MaterializePDT startPdtBuild($model_name, $view_name, $force_rebuild, $force_full_incremental, $workspace, $source)

Start a PDT materialization

Enqueue materialization for a PDT with the given model name and view name

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\DerivedTableApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$model_name = "model_name_example"; // string | The model of the PDT to start building.
$view_name = "view_name_example"; // string | The view name of the PDT to start building.
$force_rebuild = "force_rebuild_example"; // string | Force rebuild of required dependent PDTs, even if they are already materialized.
$force_full_incremental = "force_full_incremental_example"; // string | Force involved incremental PDTs to fully re-materialize.
$workspace = "workspace_example"; // string | Workspace in which to materialize selected PDT ('dev' or default 'production').
$source = "source_example"; // string | The source of this request.

try {
    $result = $apiInstance->startPdtBuild($model_name, $view_name, $force_rebuild, $force_full_incremental, $workspace, $source);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DerivedTableApi->startPdtBuild: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
model_name string The model of the PDT to start building.
view_name string The view name of the PDT to start building.
force_rebuild string Force rebuild of required dependent PDTs, even if they are already materialized. [optional]
force_full_incremental string Force involved incremental PDTs to fully re-materialize. [optional]
workspace string Workspace in which to materialize selected PDT ('dev' or default 'production'). [optional]
source string The source of this request. [optional]

Return type

\Swagger\Client\Model\MaterializePDT

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

stopPdtBuild

\Swagger\Client\Model\MaterializePDT stopPdtBuild($materialization_id, $source)

Stop a PDT materialization

Stop a PDT materialization

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\DerivedTableApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$materialization_id = "materialization_id_example"; // string | The materialization id to stop.
$source = "source_example"; // string | The source of this request.

try {
    $result = $apiInstance->stopPdtBuild($materialization_id, $source);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DerivedTableApi->stopPdtBuild: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
materialization_id string The materialization id to stop.
source string The source of this request. [optional]

Return type

\Swagger\Client\Model\MaterializePDT

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]