C# Class LoveSeat.CouchClient

Used as the starting point for any communication with CouchDB

Inheritance: LoveSeat.Support.CouchBase

Mostrar archivo Open project: soitgoes/LoveSeat Class Usage Examples

Protected Properties

Property	Type	Description
authType	AuthenticationType

Public Methods

Method	Description
CouchClient ( ) : System	This is only intended for use if your CouchDb is in Admin Party
CouchClient ( LoveSeat.CouchConfiguration config ) : System	CouchClient constructor
CouchClient ( string baseUri ) : System	The full uri for the couch constructor
CouchClient ( string host, int port, string username, string password, bool isHttps, AuthenticationType aT ) : System	Constructs the CouchClient and gets an authentication cookie (10 min)
CouchClient ( string username, string password ) : System	CouchClient constructor
CreateAdminUser ( string usernameToCreate, string passwordToCreate ) : LoveSeat.CouchResponseObject	Creates an admin user
CreateDatabase ( string databaseName ) : LoveSeat.CouchResponseObject	Creates a database
CreateUser ( string usernameToCreate, string passwordToCreate ) : LoveSeat.CouchResponseObject	Create a user in the _user database
DeleteAdminUser ( string userToDelete ) : void	Deletes admin user (if you have permission)
DeleteDatabase ( string databaseName ) : LoveSeat.CouchResponseObject	Deletes the specified database
DeleteUser ( string userToDelete ) : void	Deletes user (if you have permission)
GetDatabase ( string databaseName ) : CouchDatabase	Gets a Database object
GetUUID ( int count ) : UniqueIdentifiers	Get's UUID from CouchDB. Limit 50 uuid requests.
GetUser ( string userId ) : Document	Get's the user.
HasDatabase ( string databaseName ) : bool	Returns a bool indicating whether or not the database exists.
HasUser ( string userId ) : bool	Returns true/false depending on whether or not the user is contained in the _users database
TriggerReplication ( string source, string target ) : LoveSeat.CouchResponseObject
TriggerReplication ( string source, string target, bool continuous ) : LoveSeat.CouchResponseObject	Triggers one way replication from the source to target. If bidirection is needed call this method twice with the source and target args reversed.

Method Details

CouchClient() public method

This is only intended for use if your CouchDb is in Admin Party

public CouchClient ( ) : System
return	System

CouchClient() public method

CouchClient constructor

public CouchClient ( LoveSeat.CouchConfiguration config ) : System
config	LoveSeat.CouchConfiguration
return	System

CouchClient() public method

The full uri for the couch constructor

public CouchClient ( string baseUri ) : System
baseUri	string	Base Url with authentication to couch. Should NOT include database
return	System

CouchClient() public method

Constructs the CouchClient and gets an authentication cookie (10 min)

public CouchClient ( string host, int port, string username, string password, bool isHttps, AuthenticationType aT ) : System
host	string	The hostname of the CouchDB instance
port	int	The port of the CouchDB instance
username	string	The username of the CouchDB instance
password	string	The password of the CouchDB instance
isHttps	bool
aT	AuthenticationType
return	System

CouchClient() public method

CouchClient constructor

public CouchClient ( string username, string password ) : System
username	string
password	string
return	System

CreateAdminUser() public method

Creates an admin user

public CreateAdminUser ( string usernameToCreate, string passwordToCreate ) : LoveSeat.CouchResponseObject
usernameToCreate	string
passwordToCreate	string
return	LoveSeat.CouchResponseObject

CreateDatabase() public method

Creates a database

public CreateDatabase ( string databaseName ) : LoveSeat.CouchResponseObject
databaseName	string	Name of new database
return	LoveSeat.CouchResponseObject

CreateUser() public method

Create a user in the _user database

public CreateUser ( string usernameToCreate, string passwordToCreate ) : LoveSeat.CouchResponseObject
usernameToCreate	string
passwordToCreate	string
return	LoveSeat.CouchResponseObject

DeleteAdminUser() public method

Deletes admin user (if you have permission)

public DeleteAdminUser ( string userToDelete ) : void
userToDelete	string
return	void

DeleteDatabase() public method

Deletes the specified database

public DeleteDatabase ( string databaseName ) : LoveSeat.CouchResponseObject
databaseName	string	Database to delete
return	LoveSeat.CouchResponseObject

DeleteUser() public method

Deletes user (if you have permission)

public DeleteUser ( string userToDelete ) : void
userToDelete	string
return	void

GetDatabase() public method

Gets a Database object

public GetDatabase ( string databaseName ) : CouchDatabase
databaseName	string	Name of database to fetch
return	CouchDatabase

GetUUID() public method

Get's UUID from CouchDB. Limit 50 uuid requests.

public GetUUID ( int count ) : UniqueIdentifiers
count	int
return	UniqueIdentifiers

GetUser() public method

Get's the user.

public GetUser ( string userId ) : Document
userId	string
return	Document

HasDatabase() public method

Returns a bool indicating whether or not the database exists.

public HasDatabase ( string databaseName ) : bool
databaseName	string
return	bool

HasUser() public method

Returns true/false depending on whether or not the user is contained in the _users database

public HasUser ( string userId ) : bool
userId	string
return	bool

TriggerReplication() public method

public TriggerReplication ( string source, string target ) : LoveSeat.CouchResponseObject
source	string
target	string
return	LoveSeat.CouchResponseObject

TriggerReplication() public method

Triggers one way replication from the source to target. If bidirection is needed call this method twice with the source and target args reversed.

public TriggerReplication ( string source, string target, bool continuous ) : LoveSeat.CouchResponseObject
source	string	Uri or database name of database to replicate from
target	string	Uri or database name of database to replicate to
continuous	bool	Whether or not CouchDB should continue to replicate going forward on it's own
return	LoveSeat.CouchResponseObject

Property Details

authType protected_oe property

protected AuthenticationType authType
return	AuthenticationType