search

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 CreateBuilder() *cobra.Command
• func DeleteBuilder() *cobra.Command
• func DescribeBuilder() *cobra.Command
• func IndexesBuilder() *cobra.Command
• func ListBuilder() *cobra.Command
• func UpdateBuilder() *cobra.Command
• type CreateOpts
  • func (opts *CreateOpts) Run() error
• type DeleteOpts
  • func (opts *DeleteOpts) Run() error
• type DescribeOpts
  • func (opts *DescribeOpts) Run() error
• type IndexOpts
• type ListOpts
  • func (opts *ListOpts) Run() error
• type UpdateOpts
  • func (opts *UpdateOpts) Run() error

Functions

func Builder

func Builder() *cobra.Command

func CreateBuilder

func CreateBuilder() *cobra.Command

CreateBuilder Create an online archive for a cluster.

Usage:

mongocli atlas clusters search index create [indexName] [flags]

Flags:

    --analyzer string         Analyzer to use when creating the index (default "lucene.standard")
    --clusterName string      Name of the cluster.
    --collection string       Collection name.
    --db string               Database name.
    --dynamic                 Indicates whether the index uses dynamic or static mappings.
    --field strings           Static field specifications.
-h, --help                    help for create
    --projectId string        Project ID to use. Overrides configuration file or environment variable settings.
    --searchAnalyzer string   Analyzer to use when searching the index. (default "lucene.standard")
-f, --file string             JSON file to use in order to create the index

Global Flags:

-P, --profile string   Profile to use from your configuration file.

func DeleteBuilder

func DeleteBuilder() *cobra.Command

mongocli atlas cluster(s) search(s) index(es) delete <id> [--clusterName name][--projectId projectId][--force].

func DescribeBuilder

func DescribeBuilder() *cobra.Command

mongocli atlas cluster(s) search indexes describe <ID> [--clusterName name][--projectId projectId].

func IndexesBuilder

func IndexesBuilder() *cobra.Command

func ListBuilder

func ListBuilder() *cobra.Command

mongocli atlas clusters search(s) list [--projectId projectId] [--clusterName name][--db database][--collection collName].

func UpdateBuilder

func UpdateBuilder() *cobra.Command

UpdateBuilder Update a search index for a cluster.

Usage:

mongocli atlas clusters search indexes update <ID> [flags]

Flags:

    --analyzer string         Analyzer to use when creating the index (default "lucene.standard")
    --clusterName string      Name of the cluster.
    --collection string       Collection name.
    --db string               Database name.
    --dynamic                 Indicates whether the index uses dynamic or static mappings.
    --field strings           Static field specifications.
-h, --help                    help for update
    --indexName string        Name of the cluster.
    --projectId string        Project ID to use. Overrides configuration file or environment variable settings.
    --searchAnalyzer string   Analyzer to use when searching the index. (default "lucene.standard")
-f, --file string             JSON file to use in order to update the index

Global Flags:

-P, --profile string   Profile to use from your configuration file.

Types

type CreateOpts

type CreateOpts struct {
	cli.GlobalOpts
	cli.OutputOpts
	IndexOpts
	// contains filtered or unexported fields
}

func (*CreateOpts) Run

func (opts *CreateOpts) Run() error

type DeleteOpts

type DeleteOpts struct {
	cli.GlobalOpts
	*cli.DeleteOpts
	// contains filtered or unexported fields
}

func (*DeleteOpts) Run

func (opts *DeleteOpts) Run() error

type DescribeOpts

type DescribeOpts struct {
	cli.GlobalOpts
	cli.OutputOpts
	// contains filtered or unexported fields
}

func (*DescribeOpts) Run

func (opts *DescribeOpts) Run() error

type IndexOpts

type IndexOpts struct {
	// contains filtered or unexported fields
}

type ListOpts

type ListOpts struct {
	cli.GlobalOpts
	cli.OutputOpts
	cli.ListOpts
	// contains filtered or unexported fields
}

func (*ListOpts) Run

func (opts *ListOpts) Run() error

type UpdateOpts

type UpdateOpts struct {
	cli.GlobalOpts
	cli.OutputOpts
	IndexOpts
	// contains filtered or unexported fields
}

func (*UpdateOpts) Run

func (opts *UpdateOpts) Run() error