ColumnPrimaryKey Property

If PrimaryKey is set to true, the column will be used as a primary key.

Syntax

 spsite.getColumnPrimaryKey(index, [callback])
 spsite.setColumnPrimaryKey(index,  columnPrimaryKey, [callback])

Default Value

FALSE

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getColumnPrimaryKey([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setColumnPrimaryKey([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

If ColumnPrimaryKey is set to true, the column will be used as a primary key.

The size of the array is controlled by the ColumnCount property.

This property is not available at design time.

Data Type

Boolean