Documentation
¶
Overview ¶
Copyright 2020 MongoDB Inc
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Index ¶
- func Builder() *cobra.Command
- func ClustersBuilder() *cobra.Command
- func ClustersCreateBuilder() *cobra.Command
- func ClustersDeleteBuilder() *cobra.Command
- func ClustersDescribeBuilder() *cobra.Command
- func ClustersIndexesBuilder() *cobra.Command
- func ClustersIndexesCreateBuilder() *cobra.Command
- func ClustersListBuilder() *cobra.Command
- func ClustersPauseBuilder() *cobra.Command
- func ClustersStartBuilder() *cobra.Command
- func ClustersUpdateBuilder() *cobra.Command
- func ClustersWatchBuilder() *cobra.Command
- func DBUsersBuilder() *cobra.Command
- func DBUsersCreateBuilder() *cobra.Command
- func DBUsersDeleteBuilder() *cobra.Command
- func DBUsersListBuilder() *cobra.Command
- func DBUsersUpdateBuilder() *cobra.Command
- func LogsBuilder() *cobra.Command
- func LogsDownloadBuilder() *cobra.Command
- func MetricsBuilder() *cobra.Command
- func MetricsDatabasesBuilder() *cobra.Command
- func MetricsDatabasesListBuilder() *cobra.Command
- func MetricsDisksBuilder() *cobra.Command
- func MetricsDisksDescribeBuilder() *cobra.Command
- func MetricsDisksListBuilder() *cobra.Command
- func MetricsProcessBuilder() *cobra.Command
- func ProcessListBuilder() *cobra.Command
- func ProcessesBuilder() *cobra.Command
- type ClustersCreateOpts
- type ClustersDeleteOpts
- type ClustersDescribeOpts
- type ClustersIndexesCreateOpts
- type ClustersListOpts
- type ClustersPauseOpts
- type ClustersStartOpts
- type ClustersUpdateOpts
- type ClustersWatchOpts
- type DBUsersCreateOpts
- type DBUsersDeleteOpts
- type DBUsersListOpts
- type DBUsersUpdateOpts
- type LogsDownloadOpts
- type MetricsDatabasesListsOpts
- type MetricsDisksDescribeOpts
- type MetricsProcessOpts
- type ProcessesListOpts
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ClustersBuilder ¶
func ClustersCreateBuilder ¶
ClustersCreateBuilder builds a cobra.Command that can run as: create <name> --projectId projectId --provider AWS|GCP|AZURE --region regionName [--members N] [--tier M#] [--diskSizeGB N] [--backup] [--mdbVersion]
func ClustersDeleteBuilder ¶
mongocli atlas cluster(s) delete <name> --projectId projectId [--confirm]
func ClustersDescribeBuilder ¶
mongocli atlas cluster(s) describe <name> --projectId projectId
func ClustersIndexesBuilder ¶
func ClustersIndexesCreateBuilder ¶
ClustersIndexesCreateBuilder builds a cobra.Command that can run as: mcli atlas clusters index create [name] --clusterName clusterName --collection collection --dbName dbName [--key field:type]
func ClustersListBuilder ¶
mongocli atlas cluster(s) list --projectId projectId [--page N] [--limit N]
func ClustersPauseBuilder ¶
mongocli atlas cluster(s) pause <name> [--projectId projectId]
func ClustersStartBuilder ¶
mongocli atlas cluster(s) start <name> [--projectId projectId]
func ClustersUpdateBuilder ¶
mongocli atlas cluster(s) update [name] --projectId projectId [--tier M#] [--diskSizeGB N] [--mdbVersion]
func ClustersWatchBuilder ¶
mongocli atlas cluster(s) watch <name> [--projectId projectId]
func DBUsersBuilder ¶
func DBUsersCreateBuilder ¶
mongocli atlas dbuser(s) create --username username --password password --role roleName@dbName [--projectId projectId]
func DBUsersDeleteBuilder ¶
mongocli atlas dbuser(s) delete <username> --force
func DBUsersListBuilder ¶
mongocli atlas dbuser(s) list --projectId projectId [--page N] [--limit N]
func DBUsersUpdateBuilder ¶
mongocli atlas dbuser(s) update <username> [--password password] [--role roleName@dbName] [--projectId projectId]
func LogsBuilder ¶
func LogsDownloadBuilder ¶
mongocli atlas logs download <hostname> <logname> [--type type] [--output destination] [--projectId projectId]
func MetricsBuilder ¶
func MetricsDatabasesBuilder ¶
func MetricsDatabasesListBuilder ¶
mongocli atlas metric(s) process(es) disks lists <hostname:port>
func MetricsDisksBuilder ¶
func MetricsDisksDescribeBuilder ¶
mcli atlas metric(s) disk(s) describe <host:port> <name> --granularity g --period p --start start --end end [--type type] [--projectId projectId]
func MetricsDisksListBuilder ¶
mongocli atlas metric(s) process(es) disks lists <hostname:port>
func MetricsProcessBuilder ¶
mongocli atlas metric(s) process(es) <hostname:port> [--granularity granularity] [--period period] [--start start] [--end end] [--type type][--projectId projectId]
func ProcessListBuilder ¶
mongocli atlas process(es) list --projectId projectId [--page N] [--limit N]
func ProcessesBuilder ¶
Types ¶
type ClustersCreateOpts ¶
type ClustersCreateOpts struct {
cli.GlobalOpts
// contains filtered or unexported fields
}
func (*ClustersCreateOpts) Run ¶
func (opts *ClustersCreateOpts) Run() error
type ClustersDeleteOpts ¶
type ClustersDeleteOpts struct {
cli.GlobalOpts
*cli.DeleteOpts
// contains filtered or unexported fields
}
func (*ClustersDeleteOpts) Run ¶
func (opts *ClustersDeleteOpts) Run() error
type ClustersDescribeOpts ¶
type ClustersDescribeOpts struct {
cli.GlobalOpts
// contains filtered or unexported fields
}
func (*ClustersDescribeOpts) Run ¶
func (opts *ClustersDescribeOpts) Run() error
type ClustersIndexesCreateOpts ¶
type ClustersIndexesCreateOpts struct {
cli.GlobalOpts
// contains filtered or unexported fields
}
func (*ClustersIndexesCreateOpts) Run ¶
func (opts *ClustersIndexesCreateOpts) Run() error
type ClustersListOpts ¶
type ClustersListOpts struct {
cli.GlobalOpts
cli.ListOpts
// contains filtered or unexported fields
}
func (*ClustersListOpts) Run ¶
func (opts *ClustersListOpts) Run() error
type ClustersPauseOpts ¶
type ClustersPauseOpts struct {
cli.GlobalOpts
// contains filtered or unexported fields
}
func (*ClustersPauseOpts) Run ¶
func (opts *ClustersPauseOpts) Run() error
type ClustersStartOpts ¶
type ClustersStartOpts struct {
cli.GlobalOpts
// contains filtered or unexported fields
}
func (*ClustersStartOpts) Run ¶
func (opts *ClustersStartOpts) Run() error
type ClustersUpdateOpts ¶
type ClustersUpdateOpts struct {
cli.GlobalOpts
// contains filtered or unexported fields
}
func (*ClustersUpdateOpts) Run ¶
func (opts *ClustersUpdateOpts) Run() error
type ClustersWatchOpts ¶
type ClustersWatchOpts struct {
cli.GlobalOpts
// contains filtered or unexported fields
}
func (*ClustersWatchOpts) Run ¶
func (opts *ClustersWatchOpts) Run() error
type DBUsersCreateOpts ¶
type DBUsersCreateOpts struct {
cli.GlobalOpts
// contains filtered or unexported fields
}
func (*DBUsersCreateOpts) Prompt ¶
func (opts *DBUsersCreateOpts) Prompt() error
func (*DBUsersCreateOpts) Run ¶
func (opts *DBUsersCreateOpts) Run() error
type DBUsersDeleteOpts ¶
type DBUsersDeleteOpts struct {
cli.GlobalOpts
*cli.DeleteOpts
// contains filtered or unexported fields
}
func (*DBUsersDeleteOpts) Run ¶
func (opts *DBUsersDeleteOpts) Run() error
type DBUsersListOpts ¶
type DBUsersListOpts struct {
cli.GlobalOpts
cli.ListOpts
// contains filtered or unexported fields
}
func (*DBUsersListOpts) Run ¶
func (opts *DBUsersListOpts) Run() error
type DBUsersUpdateOpts ¶
type DBUsersUpdateOpts struct {
cli.GlobalOpts
// contains filtered or unexported fields
}
func (*DBUsersUpdateOpts) Run ¶
func (opts *DBUsersUpdateOpts) Run() error
type LogsDownloadOpts ¶
type LogsDownloadOpts struct {
cli.GlobalOpts
// contains filtered or unexported fields
}
func (*LogsDownloadOpts) Run ¶
func (opts *LogsDownloadOpts) Run() error
type MetricsDatabasesListsOpts ¶
type MetricsDatabasesListsOpts struct {
cli.GlobalOpts
cli.ListOpts
// contains filtered or unexported fields
}
func (*MetricsDatabasesListsOpts) Run ¶
func (opts *MetricsDatabasesListsOpts) Run() error
type MetricsDisksDescribeOpts ¶
type MetricsDisksDescribeOpts struct {
cli.GlobalOpts
cli.MetricsOpts
// contains filtered or unexported fields
}
func (*MetricsDisksDescribeOpts) Run ¶
func (opts *MetricsDisksDescribeOpts) Run() error
type MetricsProcessOpts ¶
type MetricsProcessOpts struct {
cli.GlobalOpts
cli.MetricsOpts
// contains filtered or unexported fields
}
func (*MetricsProcessOpts) Run ¶
func (opts *MetricsProcessOpts) Run() error
type ProcessesListOpts ¶
type ProcessesListOpts struct {
cli.GlobalOpts
cli.ListOpts
// contains filtered or unexported fields
}
func (*ProcessesListOpts) Run ¶
func (opts *ProcessesListOpts) Run() error
Source Files
¶
- atlas.go
- clusters.go
- clusters_create.go
- clusters_delete.go
- clusters_describe.go
- clusters_indexes.go
- clusters_indexes_create.go
- clusters_list.go
- clusters_pause.go
- clusters_start.go
- clusters_update.go
- clusters_watch.go
- dbusers.go
- dbusers_create.go
- dbusers_delete.go
- dbusers_list.go
- dbusers_update.go
- logs.go
- logs_download.go
- metrics.go
- metrics_databases.go
- metrics_databases_list.go
- metrics_disks.go
- metrics_disks_describe.go
- metrics_disks_list.go
- metrics_processes.go
- processes.go
- processes_list.go