describe


Lists the master replica of an object

Applicability

Product
Command type
MultiSite
multiutil subcommand

Platform
UNIX
Windows

Synopsis

describe [ –cl·an clan-name ] [ –site site-name ] –fam·ily family-name
–u·ser username [ –p·assword ] password
[ –all | –local | object-selector ... ]

Description

This command lists the master replica of one or more objects in a replica. To determine which replica masters a record, look at the value of the ratl_mastership field.

Restrictions

You must have Super User privileges.

Options and Arguments

Specifying the Clan, Site, and Family

Default
Clan: First clan replicated at this site. If there is more than one clan at the site, –clan is required.
Site: Current site. If there is more than one site on this host, –site is required.
Family: No default; you must specify a family.

–cl·an clan-name
Name of the replica’s clan.

–site site-name
Name of the replica’s site.

–fam·ily family-name
User database family: Database name given to the user database when it was created.

Schema repository family: The family name is MASTR.

Specifying a User Name and Password

Default
You must specify a user name and password.

–u·ser user
Name of a user with Super User privileges.

–p·assword password
Password associated with the specified user.

Specifying Objects to Be Described

Default
Lists the master replica of all objects in the specified replica.

–all
Lists the master replica of each item in the specified family.

–local
Lists only those objects mastered by the current site in the specified family.

object-selector ...
Objects to be described. Specify object-selector in one of the following forms:

Object
Syntax
Record
record-type:record-id
User or group
user:username
group:group-name
Public Workspace item
"workspace:Public Queries\folder-name\query-name"
Personal Workspace item
"workspace:Personal Queries(username)\folder-name\query-name"
Stateless record whose name is not unique
record-type:record-id<keysite-name>
Workspace item whose name is not unique
"workspace:query-name<keysite-name>"
User or group whose name is not unique
user:username<keysite-name>
group:group-name<keysite-name>

For information about making names unique, see Resolving Naming Conflicts.

Examples

In these examples, the lines are broken for readability. You must enter each command on a single physical line.

See Also

chmaster, syncreplica