2023.05

2023.05

  • Imply
  • Ingest
  • Query
  • Visualize
  • Administer
  • Deploy

›View Manager

Overview

  • About Imply administration

Manager

  • Using Imply Manager
  • Managing Imply clusters
  • Imply Manager security
  • Extensions

Users

  • Imply Manager users
  • Druid API access
  • Authentication and Authorization

    • Get started with Imply Hybrid Auth
    • Authentication
    • Local users
    • User roles
    • User groups
    • User sessions
    • Brute force attack detection
    • Identity provider integration
    • Okta OIDC integration
    • Okta SAML integration
    • LDAP integration
    • OAuth client authentication

Clarity

  • Monitoring
  • Set up SaaS Clarity
  • Cloudwatch monitoring
  • Metrics

Druid administration

  • Configuration reference
  • Logging
  • API reference
  • Druid design

    • Design
    • Segments
    • Processes and servers
    • Deep storage
    • Metadata storage
    • ZooKeeper

    Data management

    • Overview
    • Data updates
    • Data deletion
    • Schema changes
    • Compaction
    • Automatic compaction

    Security

    • Security overview
    • User authentication and authorization
    • LDAP auth
    • Dynamic Config Providers
    • Password providers
    • Authentication and Authorization
    • TLS support
    • Row and column level security

    Performance tuning

    • Basic cluster tuning
    • Segment size optimization
    • Mixed workloads
    • HTTP compression
    • Automated metadata cleanup

    View Manager

    • View Manager
    • View Manager API
    • Create a view
    • List views
    • Delete a view
    • Inspect view load status
  • Rolling updates
  • Using rules to drop and retain data
  • Alerts
  • Java runtime
  • Working with different versions of Apache Hadoop
  • Misc

    • dump-segment tool
    • reset-cluster tool
    • pull-deps tool
    • Deep storage migration
    • Export Metadata Tool
    • Metadata Migration

View Manager API

> Imply View Manager is an [alpha feature](/latest/preview-features) that should be considered preview and subject to change or removal at any time. Alpha features are provided "as is," and are not subject to Imply SLAs.

The View Manager lets you define views that expose only a subset of data for a datasource. The view manager is a key feature for Druid's Row and column security model.

Prerequisites

You can use the SQL View Manager API to create, update, list, inspect, and check the load status for a view. To use the API:

  • Enable the SQL View Manager. See Load the View Manager extension for instructions.
  • You need READ and WRITE access to the CONFIG resource type with name CONFIG, enabled by default for the "admin" role. For example:
    {
    "resource": {
     "name": ".*",
     "type": "CONFIG"
    },
    "action": "READ"
    },
     {
    "resource": {
     "name": ".*",
      "type": "CONFIG"
    },
     "action": "WRITE"
    }
    

To use restrict user access using views, you must enable security with druid, see Row and column security and Basic Security. For the permissions that apply to VIEW resource types, see Managing view access.

Authentication

Unless protected by an API Gateway, the View Manager API uses basic authentication. For example:

curl --location --request POST 'http://localhost:8081/druid-ext/view-manager/v1/views/english' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Basic <encoded authorization string>' \
--data-raw '{
  "viewSql": "SELECT __time, added, channel, page FROM druid.wikipedia WHERE channel = '\''#en.wikipedia'\''"
}'

View Manager Endpoints

The View Manager API includes the following endpoints for view management:

  • Create a view: POST /druid-ext/view-manager/v1/views/{view name}
  • Inspect views: GET /druid-ext/view-manager/v1/views/
  • Delete views: DELETE /druid-ext/view-manager/v1/views/{view name}
  • Inspect the load status for a single view: GET /druid-ext/view-manager/v1/views/loadstatus/{view name}

Learn more

See the following topics for more information:

  • Row and column level security to learn how to use views to secure data.
  • View Manager for a description of the Imply View Manager.
Last updated on 11/17/2022
← View ManagerCreate a view →
  • Prerequisites
  • Authentication
  • View Manager Endpoints
  • Learn more
2023.05
Key links
Try ImplyApache Druid siteImply GitHub
Get help
Stack OverflowSupportContact us
Learn more
Apache Druid forumsBlog
Copyright © 2023 Imply Data, Inc