Add-CompactType - PowerShell Cmdlet
This PowerShell Cmdlet enables the user to register a custom object for compact serialization for the given caches. The PowerShell Cmdlet enables the users to add a class to cache configuration with some of the attributes marked as non-compact whereas the rest are compact serialized.
Note
This feature is only available in NCache Enterprise.
Note
Please note that when using the NCache .NET Edition, you will require .dll libraries instead of .jar assemblies for this PowerShell Cmdlet.
Add-CompactType -AssemblyPath [-CacheName] -Class [-NonCompactAttributes] [-Port] [-Server] [-Credentials] [-NoLogo]
Examples of Add-CompactType - PowerShell Cmdlet
- This command configures the object class Customers compact serializable for a cache named demoCache.
Add-CompactType -CacheName demoCache -AssemblyPath C:\Data.jar -Class Data.Customer
- This command configures the object class Customers compact serializable for a cache named demoCache and marks the attributes CustomerID and FirstName as non-compact.
Add-CompactType -CacheName demoCache -AssemblyPath C:\Data.jar -Class Data.Customer -NonCompactAttributes "CustomerID'$'FirstName"
- This command configures the object class Customers compact serializable for a cache named demoCache and marks the attributes CustomerID and FirstName as non-compact on the server node 20.200.20.11.
Add-CompactType -CacheName demoCache -AssemblyPath C:\Data.jar -Class Data.Customer -NonCompactAttributes "CustomerID'$'FirstName" –Server 20.200.20.11
Properties
Note
The parameters with asterisk (*) on their names are the required parameters and the rest are optional.
| Parameters | Data Types | Description | Default Value |
|---|---|---|---|
-AssemblyPath* |
<String> |
Specifies the path of the assembly which needs to be configured as a compact type. | - |
-CacheName* |
<String> |
Specifies the name of the cache. | - |
-Class* |
<String> |
Specifies the class which needs to be serialized. | - |
-NonCompactAttributes |
<String> |
Specifies the attributes of the class which don’t need to be serialized with a delimiter ‘$’ | - |
-Server |
<String> |
Specifies the NCache server name where the NCache Service is running. | - |
-Port |
<Integer> |
Specifies the server port where NCache server is listening. | 8250 |
-Credentials |
<pscredential> |
Specifies the user credentials required to authorize access for the specified operation. These credentials should belong to a user who has appropriate permissions at the node. | - |
-NoLogo |
<SwitchParameter> |
Suppresses display of the logo banner. | False |
