SFAlterSoupLongOperation Class Reference

Inherits from	NSObject
Declared in	SFAlterSoupLongOperation.h

Overview

Use this class to configure and run alter soup “long” operations. Note that these operations can take a long time to complete.

`soupName`

Soup being altered.

@property (nonatomic, readonly, strong) NSString *soupName

Declared In

SFAlterSoupLongOperation.h

`soupTableName`

Backing table for soup being altered.

@property (nonatomic, readonly, strong) NSString *soupTableName

Declared In

SFAlterSoupLongOperation.h

`afterStep`

Last step completed.

@property (nonatomic, readonly, assign) SFAlterSoupStep afterStep

Declared In

SFAlterSoupLongOperation.h

`soupSpec`

New soup spec (optional).

@property (nonatomic, readonly, strong) SFSoupSpec *soupSpec

Declared In

SFAlterSoupLongOperation.h

`oldSoupSpec`

Old soup spec.

@property (nonatomic, readonly, strong) SFSoupSpec *oldSoupSpec

Declared In

SFAlterSoupLongOperation.h

`indexSpecs`

New index specs.

@property (nonatomic, readonly, strong) NSArray *indexSpecs

Declared In

SFAlterSoupLongOperation.h

`oldIndexSpecs`

Old index specs.

@property (nonatomic, readonly, strong) NSArray *oldIndexSpecs

Declared In

SFAlterSoupLongOperation.h

`reIndexData`

YES if soup elements should be brought to memory to be re-indexed.

@property (nonatomic, readonly, assign) BOOL reIndexData

Declared In

SFAlterSoupLongOperation.h

`store`

Instance of SmartStore.

@property (nonatomic, readonly, strong) SFSmartStore *store

Declared In

SFAlterSoupLongOperation.h

`queue`

Underlying database.

@property (nonatomic, readonly, strong) FMDatabaseQueue *queue

Declared In

SFAlterSoupLongOperation.h

`rowId`

Row ID for long_operations_status table.

@property (nonatomic, readonly, assign) long long rowId

Declared In

SFAlterSoupLongOperation.h

`– initWithStore:soupName:newIndexSpecs:reIndexData:`

Initializer for starting the alter soup operation.

- (id)initWithStore:(SFSmartStore *)store soupName:(NSString *)soupName newIndexSpecs:(NSArray *)newIndexSpecs reIndexData:(BOOL)reIndexData

Parameters

`store`	SmartStore instance.
`soupName`	Soup name.
`newIndexSpecs`	New index specs.
`reIndexData`	YES to reindex.

Return Value

The initialized self.

Declared In

SFAlterSoupLongOperation.h

`– initWithStore:rowId:details:status:`

Initializer for resuming an alter soup operation from the data stored in the long operations status table.

- (id)initWithStore:(SFSmartStore *)store rowId:(long)rowId details:(NSDictionary *)details status:(SFAlterSoupStep)status

Parameters

`store`	SmartStore instance.
`rowId`	Row ID.
`details`	Details.
`status`	Soup status.

Return Value

The initialized self.

Declared In

SFAlterSoupLongOperation.h

`– run`

Run this operation.

- (void)run

Declared In

SFAlterSoupLongOperation.h

`– runToStep:`

Run this operation up to a given step (used by tests).

- (void)runToStep:(SFAlterSoupStep)toStep

Parameters

`toStep`	Target step.

Declared In

SFAlterSoupLongOperation.h