phpAx / MongoDB Atlas / Create 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": "movies",
// "database": "sample_mflix",
// "name": "Synon",
// "mappings": {
// "dynamic": true
// },
// "analyzer": "lucene.standard",
// "synonyms": [
// {
// "name": "mySynonyms",
// "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','movies');
$json->UpdateString('database','sample_mflix');
$json->UpdateString('name','Synon');
$json->UpdateBool('mappings.dynamic',1);
$json->UpdateString('analyzer','lucene.standard');
$json->UpdateString('synonyms[0].name','mySynonyms');
$json->UpdateString('synonyms[0].source.collection','synonyms');
$json->UpdateString('synonyms[0].analyzer','lucene.standard');
// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://domain.com/api/atlas/{{version}}/groups/{{ProjectID}}/clusters/{{CLUSTER-NAME}}/fts/indexes','application/json',$json);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";
?>
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": [
]
}