Chilkat Online Tools

phpAx / MongoDB Atlas / Update an Atlas Search Index

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

$http->DigestAuth = 1;
$http->Login = 'username';
$http->Password = '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": "synonyms",
//   "database": "my_test",
//   "name": "default",
//   "mappings": {
//     "dynamic": true
//   },
//   "analyzer": "lucene.standard",
//   "synonyms": [
//     {
//       "name": "egSynonyms",
//       "source": {
//         "collection": "synonyms"
//       },
//       "analyzer": "lucene.standard"
//     }
//   ]
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('collectionName','synonyms');
$json->UpdateString('database','my_test');
$json->UpdateString('name','default');
$json->UpdateBool('mappings.dynamic',1);
$json->UpdateString('analyzer','lucene.standard');
$json->UpdateString('synonyms[0].name','egSynonyms');
$json->UpdateString('synonyms[0].source.collection','synonyms');
$json->UpdateString('synonyms[0].analyzer','lucene.standard');

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbRequestBody = new COM("Chilkat.StringBuilder");
$json->EmitSb($sbRequestBody);

// resp is a Chilkat.HttpResponse
$resp = $http->PTextSb('PATCH','https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/fts/indexes/{{INDEX-ID}}',$sbRequestBody,'utf-8','application/json',0,0);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

Curl Command

curl -X PATCH
	--digest -u 'username:password'
	-d '{
    "collectionName": "synonyms",
    "database": "my_test",
    "name": "default",
    "mappings": {
        "dynamic": true
    },
    "analyzer": "lucene.standard",
    "synonyms": [
        {
            "name": "egSynonyms",
            "source": {
                "collection": "synonyms"
            },
            "analyzer": "lucene.standard"
        }
    ]
}'
https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/fts/indexes/{{INDEX-ID}}

Postman Collection Item JSON

{
  "name": "Update an Atlas Search Index",
  "request": {
    "method": "PATCH",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"collectionName\": \"synonyms\",\n    \"database\": \"my_test\",\n    \"name\": \"default\",\n    \"mappings\": {\n        \"dynamic\": true\n    },\n    \"analyzer\": \"lucene.standard\",\n    \"synonyms\": [\n        {\n            \"name\": \"egSynonyms\",\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/{{INDEX-ID}}",
      "host": [
        "{{base_url}}"
      ],
      "path": [
        "api",
        "atlas",
        "{{version}}",
        "groups",
        "{{ProjectID}}",
        "clusters",
        "{{CLUSTER-NAME}}",
        "fts",
        "indexes",
        "{{INDEX-ID}}"
      ]
    },
    "description": "https://docs.atlas.mongodb.com/reference/api/fts-indexes-create-one/"
  },
  "response": [
  ]
}