Chilkat Online Tools

TCL / MongoDB Atlas / Create an Atlas Search Index

Back to Collection Items

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

CkHttp_put_DigestAuth $http 1
CkHttp_put_Login $http "username"
CkHttp_put_Password $http "password"

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "collectionName": "movies",
#   "database": "sample_mflix",
#   "name": "Synon",
#   "mappings": {
#     "dynamic": true
#   },
#   "analyzer": "lucene.standard",
#   "synonyms": [
#     {
#       "name": "mySynonyms",
#       "source": {
#         "collection": "synonyms"
#       },
#       "analyzer": "lucene.standard"
#     }
#   ]
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "collectionName" "movies"
CkJsonObject_UpdateString $json "database" "sample_mflix"
CkJsonObject_UpdateString $json "name" "Synon"
CkJsonObject_UpdateBool $json "mappings.dynamic" 1
CkJsonObject_UpdateString $json "analyzer" "lucene.standard"
CkJsonObject_UpdateString $json "synonyms[0].name" "mySynonyms"
CkJsonObject_UpdateString $json "synonyms[0].source.collection" "synonyms"
CkJsonObject_UpdateString $json "synonyms[0].analyzer" "lucene.standard"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/fts/indexes" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json

Curl Command

curl -X POST
	--digest -u 'username:password'
	-d '{
    "collectionName": "movies",
    "database": "sample_mflix",
    "name": "Synon",
    "mappings": {
        "dynamic": true
    },
    "analyzer": "lucene.standard",
    "synonyms": [
        {
            "name": "mySynonyms",
            "source": {
                "collection": "synonyms"
            },
            "analyzer": "lucene.standard"
        }
    ]
}'
https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/fts/indexes

Postman Collection Item JSON

{
  "name": "Create an Atlas Search Index",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"collectionName\": \"movies\",\n    \"database\": \"sample_mflix\",\n    \"name\": \"Synon\",\n    \"mappings\": {\n        \"dynamic\": true\n    },\n    \"analyzer\": \"lucene.standard\",\n    \"synonyms\": [\n        {\n            \"name\": \"mySynonyms\",\n            \"source\": {\n                \"collection\": \"synonyms\"\n            },\n            \"analyzer\": \"lucene.standard\"\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{base_url}}/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/fts/indexes",
      "host": [
        "{{base_url}}"
      ],
      "path": [
        "api",
        "atlas",
        "{{version}}",
        "groups",
        "{{ProjectID}}",
        "clusters",
        "{{CLUSTER-NAME}}",
        "fts",
        "indexes"
      ]
    },
    "description": "https://docs.atlas.mongodb.com/reference/api/fts-indexes-create-one/"
  },
  "response": [
  ]
}