perl-WWW-GoodData/gdc(1)

1GDC(1)                User Contributed Perl Documentation               GDC(1)
2
3
4

NAME

6       gdc - Client utility for GoodData on-demand Business Intelligence
7       platform
8

SYNOPSIS

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

DESCRIPTION

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

OPTIONS

17       -h, --help
18           Print a brief help message and exits.
19
20       -H, --man
21           Prints the manual page and exits.
22
23       -u, --user <email>
24           Use the identity of specified user.  See also the login command.
25
26       -p, --password
27           Log in on start, provided --user option was set as well.
28
29       -P, --project
30           Project URI. It is used as a default value for commands that accept
31           project URI option (such as rmproject and lsreports) and can be
32           changed from within the shell (see project and mkproject commands).
33
34           No checking is done with the project URI util a command that acts
35           upon the project is issued.
36
37       -r, --root
38           URL of the service API root.  Defaults to
39           <https://secure.gooddata.com/gdc/>.
40

COMMANDS

42   shell
43       Launch an interactive client session.
44
45       This is the default action that is taken unless another command is
46       specified.
47
48   login [user] [password]
49       Verify user identity and obtain an authorization token.  If no
50       credentials are supplied, global ones are used.
51
52       If the password is not specified, it is requested from terminal
53       provided terminal echo can be turned off.
54
55       This action is taken implicitly if user name has been specified.
56
57       -u, --user <email>
58           Alternative way to specifiy user login.
59
60       -p, --password
61           Alternative way to specifiy user password.
62
63   logout
64       Drop credentials if user is logged in, otherwise do nothing.
65       Automatically done upon utility exit.
66
67   project [uri]
68       Change or print the default project URI. Default project is used by
69       various commands involving projects, including mkproject and rmproject.
70
71       -P, --project
72           Project URI.  No checking is done with the project URI.
73
74   lsprojects
75       Print a list of available projects.
76
77       -v, --long
78           Add unnecessary details.
79
80   lsroles
81       Print a list of available roles in project.
82
83       -P, --project
84           Set or override the project to act on.  See global --project option
85           for the detailed description.
86
87   rmproject
88       Delete a project.
89
90       -P, --project
91           Set or override the project to act on.  See global --project option
92           for the detailed description.
93
94   mkuser <email> <firstname> <lastname>
95       Create user.
96
97       -d, --domain
98           URI of an user domain in which will be user created.
99
100           Defaults to "/gdc/account/domains/default", which is almost
101           definitely useless to you.  Get a proper domain URI from your
102           support representative.
103
104       -e, --email
105           User email.
106
107       -l, --login
108           User login. Same as email if no login is provided
109
110       -p, --password
111           User password. Will be asked for if not provided.
112
113       -f, --firstname
114           User first name.
115
116       -l, --lastname
117           User last name.
118
119       -t, --phone
120           User phone number.
121
122       -c, --company
123           User company.
124
125       -o, --sso
126           User company's DNS suffix, if SSO is used.
127
128   mkproject <title> [summary]
129       Create a project.
130
131       -t, --title
132           Title of the project.
133
134       -s, --summary
135           Descriptive summary of the project.
136
137       -e, --template
138           Project template. The list of valid project templates is available
139           from the template server:
140           <https://secure.gooddata.com/projectTemplates/>.
141
142       -d, --driver
143           Valid db engine drivers are 'Pg' (default) and 'mysql'.
144
145       -k, --token
146           Authorization token.
147
148   lsreports
149       Print a list of reports in a project.
150
151       -P, --project
152           Set or override the project to act on.  See global --project option
153           for the detailed description.
154
155       -v, --long
156           Add unnecessary details.
157
158   export
159       Export a report computation result into file.
160
161       -P, --project
162           Set or override the project to act on.  See global --project option
163           for the detailed description.
164
165       -r, --report
166           Set report URI (see lsreports).
167
168       -f, --file
169           File to place the result into.
170
171       -F, --format
172           One of pdf, xls, png (latter only valid for chart reports), Can be
173           unspecified if file name ends with a dot and format name
174           (extension).
175
176   model
177       Export a Logical Data Model (LDM) picture in PNG format into file.
178
179       -P, --project
180           Set or override the project to act on.  See global --project option
181           for the detailed description.
182
183       -f, --file
184           File to place the result into.
185
186   chmodel
187       Change a Logical Data Model (LDM) with MAQL DDL script.
188
189       The MAQL script can be either specified inline as argument to chmodel,
190       or read from file specified with --file option (see below).
191
192       -P, --project
193           Set or override the project to act on.  See global --project option
194           for the detailed description.
195
196       -f, --file
197           Read MAQL script from specified file.
198
199   upload
200       Update data set with new data.
201
202       -P, --project
203           Set or override the project to act on.  See global --project option
204           for the detailed description.
205
206       -f, --file
207           SLI Manifest of the upload.
208
209   mkobject <type> <title> <expression>
210       Create a new metadata object of a given type with expression as the
211       only content.
212
213       -T, --type
214           Type of the object.
215
216       -t, --title
217           Title of the object.
218
219       -s, --summary
220           Descriptive summary of the object.
221
222       -e, --expr
223           Expression (typically MAQL).
224
225       -u, --uri
226           Instead of creating a new object, rewrite an old one with a given
227           URI.
228
229       -P, --project
230           Set or override the project to act on.  See global --project option
231           for the detailed description.
232
233   mkreportdef <title> [summary]
234       Create a new reportDefinition in metadata.
235
236       -t, --title
237           Title of the object.
238
239       -s, --summary
240           Descriptive summary of the object.
241
242       -m, --metric
243           Add a metric by its URL.
244
245       -d, --dim
246           Add an attribute to dimensionality by its URL.
247
248       -f, --filter
249           Add a filter by its expression.
250
251       -u, --uri
252           Instead of creating a new object, rewrite an old one with a given
253           URI.
254
255       -P, --project
256           Set or override the project to act on.  See global --project option
257           for the detailed description.
258
259   help
260       Print list of available commands.
261

COPYRIGHT

273       Copyright 2011, 2012, 2013, 2014 Lubomir Rintel
274
275       Copyright 2012, 2013 Adam Stulpa, Tomas Janousek
276
277       This program is free software; you can redistribute it and/or modify it
278       under the same terms as Perl itself.
279

AUTHOR

281       Lubomir Rintel "lkundrak@v3.sk"
282
283
284
285perl v5.36.0                      2023-01-20                            GDC(1)