pinecone.getCollections

Pinecone v2.0.2 published on Wednesday, Nov 5, 2025 by pinecone-io

Schema (JSON)

pinecone-io/pulumi-pinecone

Using getCollections

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCollections(opts?: InvokeOptions): Promise<GetCollectionsResult>
function getCollectionsOutput(opts?: InvokeOptions): Output<GetCollectionsResult>

def get_collections(opts: Optional[InvokeOptions] = None) -> GetCollectionsResult
def get_collections_output(opts: Optional[InvokeOptions] = None) -> Output[GetCollectionsResult]

func GetCollections(ctx *Context, opts ...InvokeOption) (*GetCollectionsResult, error)
func GetCollectionsOutput(ctx *Context, opts ...InvokeOption) GetCollectionsResultOutput

> Note: This function is named GetCollections in the Go SDK.

public static class GetCollections 
{
    public static Task<GetCollectionsResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetCollectionsResult> Invoke(InvokeOptions? opts = null)
}

public static CompletableFuture<GetCollectionsResult> getCollections(InvokeOptions options)
public static Output<GetCollectionsResult> getCollections(InvokeOptions options)

fn::invoke:
  function: pinecone:index/getCollections:getCollections
  arguments:
    # arguments dictionary

getCollections Result

The following output properties are available:

Collections List<PineconeDatabase.Pinecone.Outputs.GetCollectionsCollection>: List of the collections in your project
Id string: Collections identifier

Collections []GetCollectionsCollection: List of the collections in your project
Id string: Collections identifier

collections List<GetCollectionsCollection>: List of the collections in your project
id String: Collections identifier

collections GetCollectionsCollection[]: List of the collections in your project
id string: Collections identifier

collections Sequence[GetCollectionsCollection]: List of the collections in your project
id str: Collections identifier

collections List<Property Map>: List of the collections in your project
id String: Collections identifier

Supporting Types

GetCollectionsCollection

Dimension int: The dimension of the vectors stored in each record held in the collection.
Environment string: The environment where the collection is hosted.
Name string: The name of the collection.
Size int: The size of the collection in bytes.
Status string: The status of the collection.
VectorCount int: The number of records stored in the collection.

Dimension int: The dimension of the vectors stored in each record held in the collection.
Environment string: The environment where the collection is hosted.
Name string: The name of the collection.
Size int: The size of the collection in bytes.
Status string: The status of the collection.
VectorCount int: The number of records stored in the collection.

dimension Integer: The dimension of the vectors stored in each record held in the collection.
environment String: The environment where the collection is hosted.
name String: The name of the collection.
size Integer: The size of the collection in bytes.
status String: The status of the collection.
vectorCount Integer: The number of records stored in the collection.

dimension number: The dimension of the vectors stored in each record held in the collection.
environment string: The environment where the collection is hosted.
name string: The name of the collection.
size number: The size of the collection in bytes.
status string: The status of the collection.
vectorCount number: The number of records stored in the collection.

dimension int: The dimension of the vectors stored in each record held in the collection.
environment str: The environment where the collection is hosted.
name str: The name of the collection.
size int: The size of the collection in bytes.
status str: The status of the collection.
vector_count int: The number of records stored in the collection.

dimension Number: The dimension of the vectors stored in each record held in the collection.
environment String: The environment where the collection is hosted.
name String: The name of the collection.
size Number: The size of the collection in bytes.
status String: The status of the collection.
vectorCount Number: The number of records stored in the collection.