v2_indexes

Creates, updates, deletes, gets or lists a v2_indexes resource.

Overview

Name	v2_indexes
Type	Resource
Id	cloudflare.vectorize.v2_indexes

Fields

The following fields are returned by SELECT queries:

get

Get Vectorize Index Response

Name	Datatype	Description
name	string	(example: example-index)
config	object
created_on	string (date-time)	Specifies the timestamp the resource was created as an ISO8601 string. (example: 2022-11-15T18:25:44.442097Z)
description	string	Specifies the description of the index. (example: This is my example index.)
modified_on	string (date-time)	Specifies the timestamp the resource was modified as an ISO8601 string. (example: 2022-11-15T18:25:44.442097Z)

list

List Vectorize Index Response

Name	Datatype	Description
name	string	(example: example-index)
config	object
created_on	string (date-time)	Specifies the timestamp the resource was created as an ISO8601 string. (example: 2022-11-15T18:25:44.442097Z)
description	string	Specifies the description of the index. (example: This is my example index.)
modified_on	string (date-time)	Specifies the timestamp the resource was modified as an ISO8601 string. (example: 2022-11-15T18:25:44.442097Z)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, index_name		Returns the specified Vectorize Index.
list	select	account_id		Returns a list of Vectorize Indexes
create	insert	account_id, name, config		Creates and returns a new Vectorize Index.
delete	delete	account_id, index_name		Deletes the specified Vectorize Index.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
index_name	string	The Vectorize index name.

SELECT examples

get

Returns the specified Vectorize Index.

SELECT
name,
config,
created_on,
description,
modified_on
FROM cloudflare.vectorize.v2_indexes
WHERE account_id = '{{ account_id }}' -- required
AND index_name = '{{ index_name }}' -- required
;

list

Returns a list of Vectorize Indexes

SELECT
name,
config,
created_on,
description,
modified_on
FROM cloudflare.vectorize.v2_indexes
WHERE account_id = '{{ account_id }}' -- required
;

INSERT examples

create

Creates and returns a new Vectorize Index.

INSERT INTO cloudflare.vectorize.v2_indexes (
config,
description,
name,
account_id
)
SELECT 
'{{ config }}' /* required */,
'{{ description }}',
'{{ name }}' /* required */,
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: v2_indexes
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the v2_indexes resource.
  - name: config
    description: |
      Specifies the type of configuration to use for the index.
    value:
      dimensions: {{ dimensions }}
      metric: "{{ metric }}"
      preset: "{{ preset }}"
  - name: description
    value: "{{ description }}"
    description: |
      Specifies the description of the index.
  - name: name
    value: "{{ name }}"

DELETE examples

delete

Deletes the specified Vectorize Index.

DELETE FROM cloudflare.vectorize.v2_indexes
WHERE account_id = '{{ account_id }}' --required
AND index_name = '{{ index_name }}' --required
;