gdc (1) - Linux Manuals

gdc: Client utility for GoodData on-demand Business Intelligence platform

Command to display gdc manual in Linux: $ man 1 gdc

NAME

gdc - Client utility for GoodData on-demand Business Intelligence platform

SYNOPSIS

gdc [global options] <command> [command options]

DESCRIPTION

gdc is the command-line and interactive client for GoodData REST-ful service API built on top of WWW::GoodData client library.

OPTIONS

-h, --help: Print a brief help message and exits.
-H, --man: Prints the manual page and exits.
-u, --user <email>: Use the identity of specified user. See also the login command.
-p, --password: Log in on start, provided --user option was set as well.
-P, --project: Project URI. It is used as a default value for commands that accept project URI option (such as rmproject and lsreports) and can be changed from within the shell (see project and mkproject commands).
No checking is done with the project URI util a command that acts upon the project is issued.
-r, --root: URL of the service API root. Defaults to <https://secure.gooddata.com/gdc/>.

COMMANDS

shell

Launch an interactive client session.

This is the default action that is taken unless another command is specified.

login [user] [password]

Verify user identity and obtain an authorization token. If no credentials are supplied, global ones are used.

If the password is not specified, it is requested from terminal provided terminal echo can be turned off.

This action is taken implicitly if user name has been specified.

-u, --user <email>: Alternative way to specifiy user login.
-p, --password: Alternative way to specifiy user password.

logout

Drop credentials if user is logged in, otherwise do nothing. Automatically done upon utility exit.

project [uri]

Change or print the default project URI. Default project is used by various commands involving projects, including mkproject and rmproject.

-P, --project: Project URI. No checking is done with the project URI.

lsprojects

Print a list of available projects.

-v, --long: Add unnecessary details.

lsroles

Print a list of available roles in project.

-P, --project: Set or override the project to act on. See global --project option for the detailed description.

rmproject

Delete a project.

-P, --project: Set or override the project to act on. See global --project option for the detailed description.

mkuser <email> <firstname> <lastname>

Create user.

-d, --domain: URI of an user domain in which will be user created.
Defaults to "/gdc/account/domains/default", which is almost definitely useless to you. Get a proper domain URI from your support representative.
-e, --email: User email.
-l, --login: User login. Same as email if no login is provided
-p, --password: User password. Will be asked for if not provided.
-f, --firstname: User first name.
-l, --lastname: User last name.
-t, --phone: User phone number.
-c, --company: User company.
-o, --sso: User company's DNS suffix, if SSO is used.

mkproject <title> [summary]

Create a project.

-t, --title: Title of the project.
-s, --summary: Descriptive summary of the project.
-e, --template: Project template. The list of valid project templates is available from the template server: <https://secure.gooddata.com/projectTemplates/>.
-d, --driver: Valid db engine drivers are 'Pg' (default) and 'mysql'.
-k, --token: Authorization token.

lsreports

Print a list of reports in a project.

-P, --project: Set or override the project to act on. See global --project option for the detailed description.
-v, --long: Add unnecessary details.

export

Export a report computation result into file.

-P, --project: Set or override the project to act on. See global --project option for the detailed description.
-r, --report: Set report URI (see lsreports).
-f, --file: File to place the result into.
-F, --format: One of pdf, xls, png (latter only valid for chart reports), Can be unspecified if file name ends with a dot and format name (extension).

model

Export a Logical Data Model (LDM) picture in PNG format into file.

-P, --project: Set or override the project to act on. See global --project option for the detailed description.
-f, --file: File to place the result into.

chmodel

Change a Logical Data Model (LDM) with MAQL DDL script.

The MAQL script can be either specified inline as argument to chmodel, or read from file specified with --file option (see below).

-P, --project: Set or override the project to act on. See global --project option for the detailed description.
-f, --file: Read MAQL script from specified file.

upload

Update data set with new data.

-P, --project: Set or override the project to act on. See global --project option for the detailed description.
-f, --file: SLI Manifest of the upload.

mkobject <type> <title> <expression>

Create a new metadata object of a given type with expression as the only content.

-T, --type: Type of the object.
-t, --title: Title of the object.
-s, --summary: Descriptive summary of the object.
-e, --expr: Expression (typically MAQL).
-u, --uri: Instead of creating a new object, rewrite an old one with a given URI.
-P, --project: Set or override the project to act on. See global --project option for the detailed description.

mkreportdef <title> [summary]

Create a new reportDefinition in metadata.

-t, --title: Title of the object.
-s, --summary: Descriptive summary of the object.
-m, --metric: Add a metric by its URL.
-d, --dim: Add an attribute to dimensionality by its URL.
-f, --filter: Add a filter by its expression.
-u, --uri: Instead of creating a new object, rewrite an old one with a given URI.
-P, --project: Set or override the project to act on. See global --project option for the detailed description.

help

Print list of available commands.

COPYRIGHT

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHOR

Lubomir Rintel "lkundrak [at] v3.sk"