Sybase::Metadata 3

Sybase::Metadata provides methods to extract and search through Sybase metadata, retrieving it for use in either general code or DB Browser applications.<br />EXPORT<br /><br /> NB: You MUST have DBI and DBD:Sybase insatlled to use this module!<br /><br />#################################################################### # # new # + Construct object and return handle # # + Input: None # # + Output: Object handle/pointer # #################################################################### Example:<br /><br />my $mdHandle = Sybase::Metadata->new();<br /><br />#################################################################### # # Initialize # + Initialize desired db connection and return global handle # NB: You MUST have DBI and DBD:Sybase insatlled to use this module! # # + Input: Pointer to hash of DB properties containing: # - Server # - User # - Password # - Database # # + Output: None but initializes db handle to be used internally # #################################################################### Example:<br /><br />my %dbHash = ( SERVER => 'BIGDB_SERVER', USER => 'SOME_USER', PASSWORD => 'changeme', DATABASE => 'BIGDB_DEV');<br /><br />my $hashPtr = %dbHash;<br /><br />my $mdHandle = Sybase::Metadata->new();<br /><br />$mdHandle->Initialize($hashPtr);<br /><br />#################################################################### # # GetDatabases # + Get a list of all databases and their space usage info # + Input : None # + Output : Ref to array of hashes containing: # DBName # DBID # Owner # CreateDate # # #################################################################### Example:<br /><br />print "Testing GetDatabases ... n";<br /><br />my $dbListRef = $mdHandle->GetDatabases();<br /><br />foreach ( @{$dbListRef}) { print "DBName = $_->{DBName}, DBID = $_->{DBID}, Owner = $_->{Owner}, CreateDate = $_->{CreateDate} n"; }<br /><br />#################################################################### # # GetTables # + Get a list of tables in present database, Useful for drill # down to table details # + Input : None # + Output : Ref to array of hashes containing: # Name (name of table) # TableOID # Owner # CreateDate # # #################################################################### Example:<br /><br />print "n Testing GetTables ... n";<br /><br />my $dbListRef = $mdHandle->GetTables();<br /><br />foreach ( @{$dbListRef}) { print "Name = $_->{Name}, TableOID = $_->{TableOID}, Owner = $_->{Owner}, CreateDate = $_->{CreateDate} n"; }<br /><br />#################################################################### # # GetProcs # + Get a list of tables in present database, Useful for drill # down to table details # + Input : None # + Output : Ref to array of hashes containing: # Name (name of proc) # ProcOID # Owner # CreateDate # #################################################################### Example:<br /><br />print "n Testing GetProcs ... n";<br /><br />my $dbListRef = $mdHandle->GetProcs();<br /><br />foreach ( @{$dbListRef}) { print "Name = $_->{Name}, ProcOID = $_->{ProcOID}, Owner = $_->{Owner}, CreateDate = $_->{CreateDate} n"; }<br /><br />#################################################################### # # GetViews # + Get a list of views in present database, Useful for drill # down to view details # + Input : None # + Output : Ref to array of hashes containing: # Name (name of view) # ViewOID # Owner # CreateDate # #################################################################### Example:<br /><br />print "n Testing GetViews ... n";<br /><br />my $dbListRef = $mdHandle->GetViews();<br /><br />foreach ( @{$dbListRef}) { print "Name = $_->{Name}, ViewOID = $_->{ViewOID}, Owner = $_->{Owner}, CreateDate = $_->{CreateDate} n"; }<br /><br />#################################################################### # # GetTriggers # + Get a list of views in present database, Useful for drill # down to view details # + Input : None # + Output : Ref to array of hashes containing: # TriggerName # TriggerOID # TableName # TableOID # #################################################################### Example:<br /><br />print "n Testing GetTriggers ... n";<br /><br />my $dbListRef = $mdHandle->GetTriggers();<br /><br />foreach ( @{$dbListRef}) { print "TriggerName = $_->{TriggerName}, TriggerOID = $_->{TriggerOID}, TableName = $_->{TableName}, TableOID = $_->{TableOID} n"; }<br /><br />#################################################################### # # GetRIs # + Get a list of referential integrities in present database # + Input : None # + Output : Ref to array of hashes containing: # Name (name of referential inegtrity) # RIOID # FromTable # FromTableOID # ToTable # ToTableOID # #################################################################### Example:<br /><br />print "n Testing GetRIs ... n";<br /><br />my $dbListRef = $mdHandle->GetRIs();<br /><br />foreach ( @{$dbListRef}) { print "Name = $_->{Name}, RIOID = $_->{RIOID}, FromTable = $_->{FromTable}, FromTableOID = $_->{FromTableOID}, ToTable = $_->{ToTable}, ToTableOID = $_->{ToTableOID} n"; }<br /><br />#################################################################### # # GetIndexes # + Get a list of indexes in present database # + Input : None # + Output : Ref to array of hashes containing: # Name (name of index) # OnTable # CreateDate # #################################################################### Example:<br /><br />print "n Testing GetIndexes ... n";<br /><br />my $dbListRef = $mdHandle->GetIndexes();<br /><br />foreach ( @{$dbListRef}) { print "Name = $_->{Name}, OnTable = $_->{OnTable}, CreateDate = $_->{CreateDate} n"; }<br /><br />#################################################################### # # DescribeTable # + Get table details including column names, types, null/not null # + Input : Table Name # + Output : Ref to array of hashes containing: # Name (of column) # Type # NullType (NULL/NOT NULL) # #################################################################### Example:<br /><br />print "n Testing DescribeTable ... n";<br /><br />my $dbListRef = $mdHandle->DescribeTable("MkEqTrade");<br /><br />foreach ( @{$dbListRef}) { print "Name -> $_->{Name}, Type = $_->{Type}, NullType = $_->{NullType} n"; }<br /><br />#################################################################### # # DescribeProc # + Get stored proc text excluding create statements, etc # + Input : Proc Name # + Output : Ref to array containing lines of text # #################################################################### Example:<br /><br />print "n Testing DescribeProc ... n";<br /><br />my $dbListRef = $mdHandle->DescribeProc("MkGetEqProduct");<br /><br />foreach ( @{$dbListRef}) { print "$_ "; }<br /><br />#################################################################### # # DescribeTrigger # + Get trigger text excluding create statements, etc # + Input : Trigger Name # + Output : Ref to array containing lines of text # #################################################################### Example:<br /><br />print "n Testing DescribeTrigger ... n";<br /><br />my $dbListRef = $mdHandle->DescribeTrigger("trigEqProdUpd");<br /><br />foreach ( @{$dbListRef}) { print "$_ "; }<br /><br />#################################################################### # # DescribeView # + Get view text excluding create statements, etc # + Input : ViewName # + Output : Ref to array containing lines of text # #################################################################### Example:<br /><br />print "n Testing DescribeView ... n";<br /><br />my $dbListRef = $mdHandle->DescribeView("vEqHeaders");<br /><br />foreach ( @{$dbListRef}) { print "$_ "; }<br /><br />#################################################################### # # GetUsers # + Get names/groups of all users in this database # + Input : None # + Output : Ref to array of hashes containing: # UserName # UserID # GroupName # GroupID # # #################################################################### Example:<br /><br />print "n Testing GetUsers ... n";<br /><br />my $dbListRef = $mdHandle->GetUsers();<br /><br />foreach ( @{$dbListRef}) { print "UserName = $_->{UserName}, UserID = $_->{UserID}, GroupName = $_->{GroupName}, GroupID = $_->{GroupID} n"; }<br /><br />#################################################################### # # GetLogins # + Get names of all server level logins # + Input : None # + Output : Ref to hash containing: # LoginName # LoginID # DefaultDB # #################################################################### Example:<br /><br />print "n Testing GetLogins ... n";<br /><br />my $dbListRef = $mdHandle->GetLogins();<br /><br />foreach ( @{$dbListRef}) { print "LoginName = $_->{LoginName}, LoginID = $_->{LoginID}, DefaultDB = $_->{DefaultDB} n"; }<br /><br />#################################################################### # # GetGroups # + Get names of all groups in present database # + Input : None # + Output : Ref to hash containing: # GroupName # GroupID # #################################################################### Example:<br /><br />print "n Testing GetGroups ... n";<br /><br />my $dbListRef = $mdHandle->GetGroups();<br /><br />foreach ( @{$dbListRef}) { print "GroupName = $_->{GroupName}, GroupID = $_->{GroupID} n"; }<br /><br />#################################################################### # # GetGroupMembers # + Get list of all members of a given group # + Input : GroupName # + Output : Ref to hash containing: # UserName # UserID # #################################################################### Example:<br /><br />print "n Testing GetGroupMembers ... n";<br /><br />my $dbListRef = $mdHandle->GetGroupMembers("app_group");<br /><br />foreach ( @{$dbListRef}) { print "UserName = $_->{UserName}, UserID = $_->{UserID} n"; }<br /><br />#################################################################### # # ExtractTableSQL # + Get entire stored proc with drop/create statements # + Input : Table Name # + Output : Ref to array containing text # #################################################################### Example:<br /><br />print "n Testing ExtractTableSQL ... n";<br /><br />my $dbListRef = $mdHandle->ExtractTableSQL("MkEqProductLog");<br /><br />foreach ( @{$dbListRef}) { print "$_ "; }<br /><br />#################################################################### # # ExtractViewSQL # + Get entire view with drop/create statements # + Input : View Name or View OID # + Output : Ref to array containing text # #################################################################### Example:<br /><br />print "n Testing ExtractViewSQL ... n";<br /><br />my $dbListRef = $mdHandle->ExtractViewSQL("vEqHeaders");<br /><br />foreach ( @{$dbListRef}) { print "$_ "; }<br /><br />#################################################################### # # ExtractProcSQL # + Get entire stored procedure with drop/create statements # + Input : Proc Name or Proc OID # + Output : Ref to array containing text # #################################################################### Example:<br /><br />print "n Testing ExtractProcSQL ... n";<br /><br />my $dbListRef = $mdHandle->ExtractProcSQL("MkGetEqProduct");<br /><br />foreach ( @{$dbListRef}) { print "$_ "; }<br /><br />#################################################################### # # ExtractTriggerSQL # + Get entire trigger with drop/create statements # + Input : Trigger Name or Trigger OID # + Output : Ref to array containing text # #################################################################### Example:<br /><br />print "n Testing ExtractTriggerSQL ... n";<br /><br />my $dbListRef = $mdHandle->ExtractTriggerSQL("trigEqProdUpd");<br /><br />foreach ( @{$dbListRef}) { print "$_ "; }<br /><br />#################################################################### # # ExtractRISQL # + Get entire referential integrity with drop/create statements # + Input : RI Name # + Output : Ref to array containing text # #################################################################### Example:<br /><br />print "n Testing ExtractRISQL ... n";<br /><br />my $dbListRef = $mdHandle->ExtractRISQL("FK_EQTRDATTR_TRDID");<br /><br />foreach ( @{$dbListRef}) { print "$_ "; }<br /><br />#################################################################### # # SearchProcNames # + Search proc names for a given text pattern or sybase # regular expression. Will validate regular expression first. # + Input : Pattern (string with Sybase Reg Ex optional) # + Output : Ref To Array of hashes containing: # ProcName # ProcOID # #################################################################### Example:<br /><br />print "n Testing SearchProcNames ... n";<br /><br />my $dbListRef = $mdHandle->SearchProcNames("%Get%");<br /><br />foreach ( @{$dbListRef}) { print "ProcName = $_->{ProcName}, ProcOID = $_->{ProcOID} n"; }<br /><br />#################################################################### # # SearchProcText # + Search proc text for a given text pattern or sybase # regular expression. Will validate regular expression first. # + Input : Pattern (string with Sybase Reg Ex optional) # + Output : Ref To Array of hashes containing: # ProcName # ProcOID # Snippett (text within proc containing pattern) # #################################################################### Example:<br /><br />print "n Testing SearchProcText ... n";<br /><br />my $dbListRef = $mdHandle->SearchProcText("%select%");<br /><br />foreach ( @{$dbListRef}) { print "ProcName = $_->{ProcName}, ProcOID = $_->{ProcOID}, Snippett = $_->{Snippett} n"; }<br /><br />#################################################################### # # SearchTriggerNames # + Search trigger names for a given text pattern or sybase # regular expression. Will validate regular expression first. # + Input : Pattern (string with Sybase Reg Ex optional) # + Output : Ref To Array of hashes containing: # TriggerName # TriggerOID # TableName # TableOID # #################################################################### Example:<br /><br />print "n Testing SearchTriggerNames ... n";<br /><br />my $dbListRef = $mdHandle->SearchTriggerNames("%[Uu]pd%");<br /><br />foreach ( @{$dbListRef}) { print "TriggerName = $_->{TriggerName}, TriggerOID = $_->{TriggerOID}, TableName = $_->{TableName}, TableOID = $_->{TableOID} n"; }<br /><br />#################################################################### # # SearchTriggerText # + Search trigger text for a given text pattern or sybase # regular expression. Will validate regular expression first. # + Input : Pattern (string with Sybase Reg Ex optional) # + Output : Ref To Array of hashes containing: # TriggerName # TriggerOID # TableName # TableOID # Snippett (piece of code containing pattern) # #################################################################### Example:<br /><br />print "n Testing SearchTriggerText ... n";<br /><br />my $dbListRef = $mdHandle->SearchTriggerText("%ISIN%");<br /><br />foreach ( @{$dbListRef}) { print "TriggerName = $_->{TriggerName}, TriggerOID = $_->{TriggerOID}, TableName = $_->{TableName}, TableOID = $_->{TableOID}, Snippett = $_->{Snippett} n"; }<br /><br />#################################################################### # # SearchColumns # + Search column names for a given text pattern or sybase # regular expression. Will validate regular expression first. # + Input : Pattern (string with Sybase Reg Ex optional) # + Output : Ref To Array of hashes containing: # ColumnName # TableName # TableOID # #################################################################### Example:<br /><br />print "n Testing SearchColumns ... n";<br /><br />my $dbListRef = $mdHandle->SearchColumns("%Product%");<br /><br />foreach ( @{$dbListRef}) { print "ColumnName = $_->{ColumnName}, TableName = $_->{TableName}, TableOID = $_->{TableOID} n"; }<br /><br />#################################################################### # # SearchTableNames # + Search table names for a given text pattern or sybase # regular expression. Will validate regular expression first. # + Input : Pattern (string with Sybase Reg Ex optional) # + Output : Ref To Array of hashes containing: # TableName # TableOID # #################################################################### Example:<br /><br />print "n Testing SearchTableNames ... n";<br /><br />my $dbListRef = $mdHandle->SearchTableNames("%Product%");<br /><br />foreach ( @{$dbListRef}) { print " TableName = $_->{TableName}, TableOID = $_->{TableOID} n"; }<br /><br />#################################################################### # # SearchViewNames # + Search view names for a given text pattern or sybase # regular expression. Will validate regular expression first. # + Input : Pattern (string with Sybase Reg Ex optional) # + Output : Ref To Array of hashes containing: # ViewName # ViewOID # #################################################################### Example:<br /><br />print "n Testing SearchViewNames ... n";<br /><br />my $dbListRef = $mdHandle->SearchViewNames("%Eq%");<br /><br />foreach ( @{$dbListRef}) { print " ViewName = $_->{ViewName}, ViewOID = $_->{ViewOID} n"; }<br /><br />#################################################################### # # SearchViewText # + Search view names for a given text pattern or sybase # regular expression. Will validate regular expression first. # + Input : Pattern (string with Sybase Reg Ex optional) # + Output : Ref To Array of hashes containing: # ViewName # ViewOID # Snippett (bit of view containing pattern) # #################################################################### Example:<br /><br />print "n Testing SearchViewText ... n";<br /><br />my $dbListRef = $mdHandle->SearchViewText("%[Ss]elect%");<br /><br />foreach ( @{$dbListRef}) { print " ViewName = $_->{ViewName}, ViewOID = $_->{ViewOID}, Snippett = $_->{Snippett} n"; }<br /><br />#################################################################### # # SearchIndexNames # + Search index names for a given text pattern or sybase # regular expression. Will validate regular expression first. # + Input : Pattern (string with Sybase Reg Ex optional) # + Output : Ref To Array of hashes containing: # IndexName # TableName # TableOID # #################################################################### Example:<br /><br />print "n Testing SearchIndexNames ... n";<br /><br />my $dbListRef = $mdHandle->SearchIndexNames("%EQ%");<br /><br />foreach ( @{$dbListRef}) { print " IndexName = $_->{IndexName}, TableName = $_->{TableName}, TableOID = $_->{TableOID} n"; }<br /><br />#################################################################### # # SearchUsers # + Search user names for a given text pattern or sybase # regular expression. Will validate regular expression first. # + Input : Pattern (string with Sybase Reg Ex optional) # + Output : Ref To Array of hashes containing: # UserName # UserID # #################################################################### Example:<br /><br />print "n Testing SearchUsers ... n";<br /><br />my $dbListRef = $mdHandle->SearchUsers("%app%");<br /><br />foreach ( @{$dbListRef}) { print " UserName = $_->{UserName}, UserID = $_->{UserID} n"; }<br /><br />#################################################################### # # SearchGroups # + Search group names for a given text pattern or sybase # regular expression. Will validate regular expression first. # + Input : Pattern (string with Sybase Reg Ex optional) # + Output : Ref To Array of hashes containing: # GroupName # GroupID # #################################################################### Example:<br /><br />print "n Testing SearchGroups ... n";<br /><br />my $dbListRef = $mdHandle->SearchGroups("%app%");<br /><br />foreach ( @{$dbListRef}) { print " GroupName = $_->{GroupName}, GroupID = $_->{GroupID} n"; }<br /><br />#################################################################### # # CloseConnection # + Clean up and close DB handle # + Input: None needed # #################################################################### Example:<br /><br />$mdHandle->CloseConnection();

Requirements:	No special requirements
Platforms:	*nix, Linux
Keyword:	Array,  Dblistref,  Exampleprint,  Expression,  Hashes,  Input,  Names,  Output,  Pattern,  Print,  Quotmy,  Regular,  Sybase,  Tablename,  Tableoid,  Testing,  Validate
Users rating:	0/10