# SalesforceDescribeClient (/docs/codegen/api/interfaces/SalesforceDescribeClient)



[@kysoql/codegen](/docs/codegen/api) / SalesforceDescribeClient

Describe client contract used by schema loading and generation.

## Methods [#methods]

<a id="api-describeglobal" />

### describeGlobal() [#describeglobal]

```ts
describeGlobal(): Promise<SalesforceGlobalDescription>;
```

Loads Salesforce global describe metadata.

#### Returns [#returns]

`Promise`\<[`SalesforceGlobalDescription`](/docs/codegen/api/interfaces/SalesforceGlobalDescription)>

***

<a id="api-describe" />

### describe() [#describe]

```ts
describe(objectName): Promise<SalesforceObjectDescription>;
```

Loads Describe metadata for one Salesforce object API name.

#### Parameters [#parameters]

| Parameter    | Type     |
| ------------ | -------- |
| `objectName` | `string` |

#### Returns [#returns-1]

`Promise`\<[`SalesforceObjectDescription`](/docs/codegen/api/interfaces/SalesforceObjectDescription)>

***

<a id="api-describebigobjectindex" />

### describeBigObjectIndex()? [#describebigobjectindex]

```ts
optional describeBigObjectIndex(objectName): Promise<readonly string[] | undefined>;
```

Loads ordered custom Big Object index fields when available.

#### Parameters [#parameters-1]

| Parameter    | Type     |
| ------------ | -------- |
| `objectName` | `string` |

#### Returns [#returns-2]

`Promise`\<readonly `string`\[] | `undefined`>

***

<a id="api-describedatacategorygroups" />

### describeDataCategoryGroups()? [#describedatacategorygroups]

```ts
optional describeDataCategoryGroups(objectName): Promise<
  | SalesforceDataCategoryGroupsResponse
| undefined>;
```

Loads data-category groups for an object when the backing client supports them.

#### Parameters [#parameters-2]

| Parameter    | Type     |
| ------------ | -------- |
| `objectName` | `string` |

#### Returns [#returns-3]

`Promise`\<
\| [`SalesforceDataCategoryGroupsResponse`](/docs/codegen/api/interfaces/SalesforceDataCategoryGroupsResponse)
\| `undefined`>