Built-in moduli

consistentRead?: boolean (facoltativo)

Un valore booleano opzionale per specificare se si desidera eseguire una lettura fortemente coerente con DynamoDB.

key: DynamoDBKey<T> (obbligatorio)

Un parametro obbligatorio che specifica la chiave dell'elemento in DynamoDB. Gli elementi DynamoDB possono avere una sola chiave hash o chiavi di hash e ordinamento.

_version?: number (facoltativo)

condition?: DynamoDBFilterObject<T> | null (facoltativo)

Quando si inserisce un oggetto in una tabella DynamoDB, è possibile specificare facoltativamente un'espressione condizionale che controlla se la richiesta deve essere completata o meno in base allo stato dell'oggetto già presente in DynamoDB prima dell'esecuzione dell'operazione.

customPartitionKey?: string (facoltativo)

Se abilitato, questo valore di stringa modifica il formato dei ds_pk record ds_sk e utilizzati dalla tabella delta sync quando il controllo delle versioni è abilitato. Se abilitata, è abilitata anche l'elaborazione della populateIndexFields voce.

item: Partial<T> (obbligatorio)

Il resto degli attributi dell'elemento da inserire in DynamoDB.

key: DynamoDBKey<T> (obbligatorio)

Un parametro obbligatorio che specifica la chiave dell'elemento in DynamoDB su cui verrà eseguito l'inserimento. Gli elementi DynamoDB possono avere una sola chiave hash o chiavi di hash e ordinamento.

populateIndexFields?: boolean (facoltativo)

Un valore booleano che, se abilitato insieme acustomPartitionKey, crea nuove voci per ogni record nella tabella delta sync, in particolare nelle colonne e. gsi_ds_pk gsi_ds_sk Per ulteriori informazioni, consulta Rilevamento e sincronizzazione dei conflitti nella Guida per gli AWS AppSync sviluppatori.

query: DynamoDBKeyCondition<Required<T>> (obbligatorio)

Specifica una condizione chiave che descrive gli elementi da interrogare. Per un determinato indice, la condizione per una chiave di partizione deve essere un'uguaglianza e la chiave di ordinamento un confronto o un beginsWith (quando si tratta di una stringa). Per le chiavi di partizione e ordinamento sono supportati solo i tipi di numeri e stringhe.

Esempio

Prendi il User tipo qui sotto:

type User = {
  id: string;
  name: string;
  age: number;
  isVerified: boolean;
  friendsIds: string[] 
}

La query può includere solo i seguenti campi: idname, eage:

const query: QueryInput<User> = {
    name: { eq: 'John' },
    age: { gt: 20 },
}

_version?: number (facoltativo)

condition?: DynamoDBFilterObject<T> (facoltativo)

Quando rimuovi un oggetto in DynamoDB, puoi facoltativamente specificare un'espressione condizionale che controlla se la richiesta deve avere successo o meno in base allo stato dell'oggetto già presente in DynamoDB prima dell'esecuzione dell'operazione.

Esempio

L'esempio seguente è un'DeleteItemespressione contenente una condizione che consente il successo dell'operazione solo se il proprietario del documento corrisponde all'utente che effettua la richiesta.

type Task = {
  id: string;
  title: string;
  description: string;
  owner: string;
  isComplete: boolean;
}
const condition: DynamoDBFilterObject<Task> = {
  owner: { eq: 'XXXXXXXXXXXXXXXX' },
}

remove<Task>({
   key: {
     id: 'XXXXXXXXXXXXXXXX',
  },
  condition,
});

customPartitionKey?: string (facoltativo)

Se abilitato, il customPartitionKey valore modifica il formato dei ds_pk record ds_sk e utilizzati dalla tabella delta sync quando il controllo delle versioni è abilitato. Se abilitata, è abilitata anche l'elaborazione della populateIndexFields voce.

key: DynamoDBKey<T> (obbligatorio)

Un parametro obbligatorio che specifica la chiave dell'elemento in DynamoDB che viene rimosso. Gli elementi DynamoDB possono avere una sola chiave hash o chiavi di hash e ordinamento.

Esempio

Se a ha User solo la chiave hash di un utenteid, la chiave sarà simile a questa:

type User = {
	id: number
	name: string
	age: number
	isVerified: boolean
}
const key: DynamoDBKey<User> = {
	id: 1,
}

Se l'utente della tabella ha una chiave hash (id) e una chiave di ordinamento (name), la chiave sarà simile a questa:

type User = {
	id: number
	name: string
	age: number
	isVerified: boolean
	friendsIds: string[]
}

const key: DynamoDBKey<User> = {
	id: 1,
	name: 'XXXXXXXXXX',
}   

populateIndexFields?: boolean (facoltativo)

Un valore booleano che, se abilitato insieme acustomPartitionKey, crea nuove voci per ogni record nella tabella delta sync, in particolare nelle gsi_ds_pk colonne e. gsi_ds_sk

consistentRead?: boolean | null (facoltativo)

Un valore booleano opzionale per indicare letture coerenti durante l'interrogazione di DynamoDB. Il valore predefinito è false.

filter?: DynamoDBFilterObject<T> | null (facoltativo)

Un filtro opzionale da applicare ai risultati dopo averlo recuperato dalla tabella.

index?: string | null (facoltativo)

Un nome opzionale dell'indice da scansionare.

limit?: number | null (facoltativo)

Un numero massimo opzionale di risultati da restituire.

nextToken?: string | null (facoltativo)

Un token di impaginazione opzionale per continuare una query precedente. dalla quale deve essere ottenuto.

scanIndexForward?: boolean | null (facoltativo)

Un valore booleano opzionale per indicare se l'interrogazione viene eseguita in ordine crescente o decrescente. Per impostazione predefinita, questo valore è impostato su true.

segment?: number (facoltativo)

select?: DynamoDBSelectAttributes (facoltativo)

Attributi da restituire da DynamoDB. Per impostazione predefinita, il resolver AWS AppSync DynamoDB restituisce solo gli attributi proiettati nell'indice. I valori supportati sono:

totalSegments?: number (facoltativo)

basePartitionKey?: string (facoltativo)

La chiave di partizione della tabella di base da utilizzare quando si esegue un'operazione di sincronizzazione. Questo campo consente di eseguire un'operazione di sincronizzazione quando la tabella utilizza una chiave di partizione personalizzata.

deltaIndexName?: string (facoltativo)

L'indice utilizzato per l'operazione di sincronizzazione. Questo indice è necessario per abilitare un'operazione di sincronizzazione sull'intera tabella delta store quando la tabella utilizza una chiave di partizione personalizzata. L'operazione di sincronizzazione verrà eseguita sul GSI (creato su gsi_ds_pk egsi_ds_sk).

filter?: DynamoDBFilterObject<T> | null (facoltativo)

Un filtro opzionale da applicare ai risultati dopo averlo recuperato dalla tabella.

lastSync?: number (facoltativo)

Il momento, in millisecondi epocali, in cui è iniziata l'ultima operazione di sincronizzazione riuscita. Se specificato, vengono restituiti solo gli elementi che sono stati modificati dopo lastSync. Questo campo deve essere compilato solo dopo aver recuperato tutte le pagine da un'operazione di sincronizzazione iniziale. Se omesso, verranno restituiti i risultati della tabella di base. Altrimenti, verranno restituiti i risultati della tabella delta.

limit?: number | null (facoltativo)

Un numero massimo opzionale di elementi da valutare contemporaneamente. Se omesso, il limite predefinito sarà impostato su 100 elementi. Il valore massimo per questo campo è 1000 articoli.

nextToken?: string | null (facoltativo)

_version?: number (facoltativo)

condition?: DynamoDBFilterObject<T> (facoltativo)

Quando si aggiorna un oggetto in DynamoDB, è possibile specificare facoltativamente un'espressione condizionale che controlla se la richiesta deve avere esito positivo o meno in base allo stato dell'oggetto già presente in DynamoDB prima dell'esecuzione dell'operazione.

customPartitionKey?: string (facoltativo)

Se abilitato, il customPartitionKey valore modifica il formato ds_sk e i ds_pk record utilizzati dalla tabella delta sync quando il controllo delle versioni è abilitato. Se abilitata, è abilitata anche l'elaborazione della populateIndexFields voce.

key: DynamoDBKey<T> (obbligatorio)

Un parametro obbligatorio che specifica la chiave dell'elemento in DynamoDB che viene aggiornato. Gli elementi DynamoDB possono avere una sola chiave hash o chiavi di hash e ordinamento.

populateIndexFields?: boolean (facoltativo)

Un valore booleano che, se abilitato insieme acustomPartitionKey, crea nuove voci per ogni record nella tabella delta sync, in particolare nelle colonne e. gsi_ds_pk gsi_ds_sk

update: DynamoDBUpdateObject<T>

Un oggetto che specifica gli attributi da aggiornare insieme ai relativi nuovi valori. L'oggetto di aggiornamento può essere utilizzato conadd,remove,replace,increment,decrement, appendprepend,updateListItem.