Collection::createIndex

(No version information available, might only be in Git)

Collection::createIndexCreate collection index

Beschreibung

public mysql_xdevapi\Collection::createIndex(string $index_name, string $index_desc_json): void

Creates an index on the collection.

An exception is thrown if an index with the same name already exists, or if index definition is not correctly formed.

Parameter-Liste

index_name

The name of the index that to create. This name must be a valid index name as accepted by the CREATE INDEX SQL query.

index_desc_json

Definition of the index to create. It contains an array of IndexField objects, and each object describes a single document member to include in the index, and an optional string for the type of index that might be INDEX (default) or SPATIAL.

A single IndexField description consists of the following fields:

  • field: string, the full document path to the document member or field to be indexed.

  • type: string, one of the supported SQL column types to map the field into. For numeric types, the optional UNSIGNED keyword may follow. For the TEXT type, the length to consider for indexing may be added.

  • required: bool, (optional) true if the field is required to exist in the document. Defaults to false, except for GEOJSON where it defaults to true.

  • options: integer, (optional) special option flags for use when decoding GEOJSON data.

  • srid: integer, (optional) srid value for use when decoding GEOJSON data.

It is an error to include other fields not described above in IndexDefinition or IndexField documents.

Rückgabewerte

Beispiele

Beispiel #1 mysql_xdevapi\Collection::createIndex() example

<?php
$session 
mysql_xdevapi\getSession("mysqlx://user:password@localhost");
$session->sql("DROP DATABASE IF EXISTS addressbook")->execute();
$session->sql("CREATE DATABASE addressbook")->execute();

$schema     $session->getSchema("addressbook");
$collection $schema->createCollection("people");

// Creating a text index
$collection->createIndex(
  
'myindex1'
  
'{"fields": [{
    "field": "$.name", 
    "type": "TEXT(25)", 
    "required": true}], 
    "unique": false}'
);

// A spatial index
$collection->createIndex(
  
'myindex2'
  
'{"fields": [{
    "field": "$.home", 
    "type": "GEOJSON", 
    "required": true}], 
    "type": "SPATIAL"}'
);

// Index with multiple fields
$collection->createIndex(
  
'myindex3'
  
'{"fields": [
    {
      "field": "$.name",
      "type": "TEXT(20)",
      "required": true
    },
    {
      "field": "$.age",
      "type": "INTEGER"
    },
    {
      "field": "$.job",
      "type": "TEXT(30)",
      "required": false
    }
  ],
  "unique": true
  }'
);

Hier Kannst Du einen Kommentar verfassen


Bitte gib mindestens 10 Zeichen ein.
Wird geladen... Bitte warte.
* Pflichtangabe
Es sind noch keine Kommentare vorhanden.

Was genau bedeutet "Vibe Coding"? Ein tiefgehender Blick für Entwickler

In der Welt der Softwareentwicklung gibt es unzählige Wege, wie man an ein Projekt herangeht. Manche schwören auf strikte Planung, andere auf bewährte Algorithmen und wieder andere lassen sich von etwas ganz anderem leiten: ihrem Gefühl. ...

admin

Autor : admin
Kategorie: Software & Web-Development

PHP cURL-Tutorial: Verwendung von cURL zum Durchführen von HTTP-Anfragen

cURL ist eine leistungsstarke PHP-Erweiterung, die es Ihnen ermöglicht, mit verschiedenen Servern über verschiedene Protokolle wie HTTP, HTTPS, FTP und mehr zu kommunizieren. ...

TheMax

Autor : TheMax
Kategorie: PHP-Tutorials

Midjourney Tutorial - Anleitung für Anfänger

Über Midjourney, dem Tool zur Erstellung digitaler Bilder mithilfe von künstlicher Intelligenz, gibt es ein informatives Video mit dem Titel "Midjourney Tutorial auf Deutsch - Anleitung für Anfänger" ...

Mike94

Autor : Mike94
Kategorie: KI Tutorials

Tutorial veröffentlichen

Tutorial veröffentlichen

Teile Dein Wissen mit anderen Entwicklern weltweit

Du bist Profi in deinem Bereich und möchtest dein Wissen teilen, dann melde dich jetzt an und teile es mit unserer PHP-Community

mehr erfahren

Tutorial veröffentlichen

Cloud Antivirus: Moderne Sicherheit aus der Datenwolke

In Zeiten zunehmender Cyberbedrohungen sind klassische Virenschutzprogramme oft nicht mehr ausreichend, um mit den ständig wachsenden Herausforde ...

Geschrieben von Codini am 03.05.2025 10:11:31
Forum: Off-Topic Diskussionen
Discourse Hosting – Die moderne Lösung für Community-Management

In einer zunehmend digitalen Welt sind starke Online-Communities ein wichtiger Erfolgsfaktor für Unternehmen, Vereine, Projekte und Organisatione ...

Geschrieben von Codini am 03.05.2025 09:03:27
Forum: Off-Topic Diskussionen
Kontakt über API anlegen per PHP

Warum bekomme ich beim Anlegen eines Kontakts über die API nur einen HTTP-Statuscode 200 statt 201, obwohl die Daten scheinbar korrekt gesendet w ...

Geschrieben von amorapotter am 03.05.2025 08:47:19
Forum: PHP Developer Forum
Tutorial: Download

The Minecraft Jason Momoa leather jacket (https://www.celebsmoviejackets.com/a-minecraft-2025-jason-momoa-leather-jacket) is a bold fusion of rugg ...

Geschrieben von sumitguptill90 am 30.04.2025 14:52:40
Forum: Tutorials