apiargs-MongoDBCollection-method-createIndex-param.yaml 377 Bytes
Newer Older
1 2 3 4 5
arg_name: param
name: $key
type: array|object
description: |
  Specifies the field or fields to index and the index order.
6 7 8 9

  For example, the following specifies a descending index on the ``username``
  field:

10 11
  .. code-block:: php

12
     [ 'username' => -1 ]
13
interface: phpmethod
14
operation: ~
15 16 17 18 19
optional: false
---
source:
  file: apiargs-common-param.yaml
  ref: $options
20
...