Content Validator

Usage

spectacles content
[-h]
[GLOBAL_FLAGS ...]
--project PROJECT
--branch BRANCH
[--import-projects]
[--remote-reset | --commit-ref COMMIT_REF]
[--explores EXPLORES [EXPLORES ...]]
[--exclude EXCLUDE [EXCLUDE ...]]
[--incremental]
[--exclude-personal]

Options

All required options in Global Flags are also required for the Content Validator.

branch

Required. Usage: --branch master

The Git branch of your Looker project to validate.

Environment Variable: LOOKER_GIT_BRANCH

commit-ref

Usage: --commit-ref ae4d8c

The commit of your project that Spectacles should checkout to validate. Spectacles will create a temporary branch for the tests based on this commit and delete the branch at the end of the validation or if an exception is handled.

Environment Variable: SPECTACLES_COMMIT_REF

exclude

Usage: --exclude model_a/explore_a model_b/*

Exclude specific models or explores from validation. This flag accepts a list of / delimited model and explore names. The wildcard operator * is also accepted to exclude all models or explores, for example model_a/* will exclude all explores in Model A.

Here's an example:

All explores except for Explore B

--exclude model_a/explore_b

exclude-personal

Usage: --exclude-personal

Ignore all errors identified in content that lives in personal folders. Personal folders are individual user folders rather than folders in the Shared folder. Provide this flag if you aren't concerned with user-specific content, e.g. because it is historical or experimental.

explores

Usage: --explores model_a/explore_a model_b/*

Select specific models or explores for validation. This flag accepts a list of / delimited model and explore names. The wildcard operator * is also accepted to choose all models or explores, for example model_a/* will select all explores in Model A.

Here are some additional examples:

Only Explore A

--explores model_a/explore_a

All explores in Model A

--explores model_a/*

Every explore named Explore A across all models

--explores */explore_a

Explore A and Explore B

--explores model_a/explore_a model_a/explore_b

import-projects

Usage: --import-projects

Create temporary branches based off of master for any project that is a dependency of the current project (as indicated in the project's manifest file). These branches are deleted at the end of the validation or if an exception is handled. You should only set this to true if there is a manifest.lkml file in your project.

If this flag is not set, Spectacles will use whatever branch was last used in development mode on each dependent project by the user.

Environment Variable: SPECTACLES_IMPORT_PROJECTS

incremental

Usage: --incremental

Spectacles will run content validation twice, once on the specified branch and once on master. Spectacles will only display content errors that are found on the specified branch but not on master. If the specified branch is master, Spectacles runs as if this flag was not provided.

This is useful in cases where you only want to identify content errors introduced by the changes on the specified branch.

project

Required. Usage: --project ecommerce

The LookML project you want to validate. Projects are listed at the bottom of the Develop menu in Looker.

Unlike the Looker Content Validator, the Spectacles Content Validator only returns errors caused by models and explores in the specified project.

Environment Variable: LOOKER_PROJECT

remote-reset

Usage: --remote-reset

Reset the branch to the version of the branch that is on the remote repository. This flag cannot be used with --commit-ref because it implicitly specifies a commit to use.

caution

Providing this flag will delete any uncommited changes in the user’s workspace.

Environment Variable: SPECTACLES_REMOTE_RESET